Come commentare in Jenkinsfile

Un Jenkinsfile può essere scritto in una sintassi della pipeline dichiarativa o scritta. Ciò consente a Jenkins di comprendere le istituzioni e i passaggi che sono definiti in pipeline. Possiamo usare Jenkinsfile per descrivere un'ampia varietà di compiti come build, test, distribuzione e altro ancora.

In un Jenkinsfile, un commento si riferisce alle righe di testo che vengono ignorate dal motore della pipeline di Jenkins durante l'esecuzione. I commenti sono utili in quanto consentono agli ingegneri DevOps di aggiungere la documentazione al file della pipeline.

In questo tutorial, impareremo come è possibile creare i vari commenti in un Jenkinsfile per aggiungere una meta documentazione al tuo file di pipeline.

Commenti in Jenkinsfile

La sintassi di un Jenkinsfile si basa sul linguaggio di programmazione Groovy. Ciò significa che possiamo usare il formato di commenti groovy per aggiungere i commenti in un filo di Jenkins.

Commenti a linea singola di Jenkinsfile

Possiamo creare i commenti a linea singola in un Jenkinsfile. Questi tipi di commenti si estendono alla fine di una determinata riga. I commenti a linea singola sono utili per aggiungere una meta informazione su un determinato blocco di codice.

Per aggiungere un commento a linea singola in un Jenkinsfile, possiamo usare i due personaggi di Slash in avanti (//). Qualsiasi testo che viene aggiunto dopo i caratteri fino alla fine della linea viene trattato come commenti.

Di seguito mostra l'esempio di un commento a linea singola in Jenkinsfile:

tubatura
agente qualsiasi
fasi
Stage ('build')
Passaggi
// Carica il plug -in OWASP dipendenza check -in
dipendencycheck (odcinstallation: "OWASP", ALTRESTARGROUMS: '-Format html-Format XML')
dipendencycheckpublisher ()


// Un altro commento a linea singola

Commenti di blocco di Jenkinsfile

Il secondo tipo di commenti in Jenkins sono i commenti di blocco. Questi sono il tipo di commenti che si estendono in più righe creando un blocco.

I commenti del blocco sono utili per aggiungere informazioni dettagliate su un determinato blocco di codice. Puoi anche usarlo per aggiungere una meta informazione come informazioni sull'autore, data di creazione, dipendenze e altro ancora.

Per creare i commenti del blocco in un Jenkinsfile, iniziamo con una barra in avanti e un carattere di asterisco (/*). Per chiudere un commento a blocchi, iniziamo con un asterisco seguito con una barra in avanti (*/).

Qualsiasi testo posizionato tra i personaggi di apertura e chiusura viene trattato come commenti. L'esempio seguente mostra l'esempio di un commento a blocchi in un file Jenkins:

tubatura
agente qualsiasi
fasi
Stage ('build')
Passaggi
/* Carica il plug -in di controllo della dipendenza OWASP
... anche un commento
... e un altro commento
... finché non chiudiamo */
E un f
dipendencycheck (odcinstallation: "OWASP", ALTRESTARGROUMS: '-Format html-Format XML')
dipendencycheckpublisher ()

Nota: i caratteri Elpses nel codice precedente fanno parte del commento e non sono necessari per un commento a blocchi.

Commenti di shell di Jenkinsfile

In alcuni casi, potrebbe essere necessario eseguire uno script di shell all'interno della pipeline Jenkins. In tal caso, è possibile aggiungere i commenti della shell usando un carattere sterlina (#).

Esempio:

tubatura
agente qualsiasi
fasi
stadio ('start')
Passaggi
sh "'
cd ~
# commento di shell che naviga nella cartella domestica
'"

Conclusione

Hai appreso i vari tipi di commenti nel file della pipeline di Jenkins. Hai anche imparato a creare tale tipo di commenti in un Jenkinsfile e il loro utilizzo corrispondente.