Hvordan kommentere i Jenkinsfile

En Jenkinsfile kan skrives i en deklarativ eller skriptet rørledningssyntaks. Dette gjør at Jenkins kan forstå institusjonene og trinnene som er definert i rørledningen. Vi kan bruke Jenkinsfile for å beskrive et bredt utvalg av oppgaver som bygg, testing, distribusjon og mer.

I en Jenkinsfile refererer en kommentar til tekstlinjene som blir ignorert av Jenkins Pipeline -motoren under utførelse. Kommentarer er gunstige da de lar DevOps -ingeniørene legge til dokumentasjonen i rørledningsfilen.

I denne opplæringen lærer vi hvordan du kan lage de forskjellige kommentarene i en Jenkinsfile for å legge til en metadokumentasjon i rørledningsfilen.

Kommentarer i Jenkinsfile

Syntaksen til en Jenkinsfile er basert på det groovy programmeringsspråket. Dette betyr at vi kan bruke groovy kommentarformat for å legge til kommentarene i en Jenkinsfile.

Jenkinsfile enkeltlinjekommentarer

Vi kan lage en-linje-kommentarene i en Jenkinsfile. Disse typer kommentarer spenner til slutten av en gitt linje. Kommentarene med en linje er nyttige for å legge til en metainformasjon om en gitt kodeblokk.

For å legge til en enkeltlinjekommentar i en Jenkinsfile, kan vi bruke de to fremover-slash-tegnene (//). Enhver tekst som er lagt til etter tegnene til slutten av linjen blir behandlet som kommentarer.

Følgende viser eksemplet på en enkeltlinjekommentar i Jenkinsfile:

rørledning
agent noen
Stadier
scene ('build')
trinn
// Last inn OWASP -avhengighetskontrollen
DependencyCheck (Odcinstallation: 'Owasp', tilleggsargumenter: '-format html-format xml')
DependencyCheckPublisher ()


// Nok en enkeltlinje kommentar

Jenkinsfile Block -kommentarer

Den andre typen kommentarer i Jenkins er blokkeringskommentarer. Dette er den typen kommentarer som spenner over flere linjer som skaper en blokk.

Blokkkommentarer er nyttige for å legge til en detaljert informasjon om en gitt kodeblokk. Du kan også bruke den til å legge til en metainformasjon som forfatterinformasjon, opprettelsesdato, avhengigheter og mer.

For å lage blokkkommentarene i en Jenkinsfile, starter vi med en fremover skråstrek og en stjerne karakter (/*). For å lukke en blokkkommentar, starter vi med en stjerne fulgt med en fremover skråstrek (*/).

Enhver tekst som er plassert mellom åpnings- og lukkende tegn blir behandlet som kommentarer. Følgende eksempel viser eksemplet på en blokkeringskommentar i en Jenkins -fil:

rørledning
agent noen
Stadier
scene ('build')
trinn
/* Last inn OWASP -avhengighetssjekk -plugin
... også en kommentar
... og en annen kommentar
... til vi lukker */
Og en f
DependencyCheck (Odcinstallation: 'Owasp', tilleggsargumenter: '-format html-format xml')
DependencyCheckPublisher ()

Merk: Elipsetegnene i forrige kode er en del av kommentaren og er ikke påkrevd for en blokkkommentar.

Jenkinsfile Shell -kommentarer

I noen tilfeller kan det hende du må utføre et skallskript i Jenkins -rørledningen. I et slikt tilfelle kan du legge til Shell -kommentarene ved hjelp av et pundkarakter (#).

Eksempel:

rørledning
agent noen
Stadier
scene ('start')
trinn
sh "'
CD ~
# skallkommentarer som navigerer til hjemmemappen
'"

Konklusjon

Du lærte om de forskjellige typer kommentarer i Jenkins Pipeline -fil. Du lærte også hvordan du lager en slik type kommentarer i en Jenkinsfile og deres tilsvarende bruk.