Jak komentować w Jenkinsfile

Jenkinsfile można zapisać w składni deklaratywnej lub skoncentrowanej. To pozwala Jenkins zrozumieć instytucje i kroki zdefiniowane w rurociągu. Możemy użyć Jenkinsfile do opisania szerokiej gamy zadań, takich jak kompilacje, testowanie, wdrażanie i wiele innych.

W Jenkinsfile komentarz odnosi się do wierszy tekstu, które są ignorowane przez silnik rurociągu Jenkins. Komentarze są korzystne, ponieważ pozwalają inżynierom DevOps dodać dokumentację do pliku rurociągu.

W tym samouczku dowiemy się, w jaki sposób możesz stworzyć różne komentarze w JenkinsFile, aby dodać meta dokumentację do pliku rurociągu.

Komentarze w Jenkinsfile

Składnia Jenkinsfile opiera. Oznacza to, że możemy użyć formatu komentarzy groovy, aby dodać komentarze w Jenkinsfile.

JenkinsFile jednodowierne komentarze

Możemy tworzyć komentarze jednoladowe w Jenkinsfile. Tego rodzaju komentarze obejmują koniec danej linii. Komentarze jednokierunkowe są przydatne do dodania meta Informacje o danym bloku kodu.

Aby dodać komentarz jednoliniowy w JenkinsFile, możemy użyć dwóch postaci do przodu (//). Każdy tekst dodawany po znakach do końca wiersza jest traktowany jako komentarze.

Poniżej pokazuje przykład jednego linii w Jenkinsfile:

rurociąg
agent dowolny
Etapy
etap („build”)
kroki
// Załaduj wtyczkę kontrolera zależności OWASP
zależnechCheck (odcinstallation: „OWASP”, dodatkowe Argumenty: '-FORMAT HTML-FORMAT XML')
zależność


// Kolejny komentarz jednoliniowy

Komentarze bloku Jenkinsfile

Drugi typ komentarzy w Jenkins to komentarze blokowe. Są to rodzaj komentarzy obejmujących wiele linii tworzących blok.

Komentarze blokowe są przydatne, aby dodać szczegółowe informacje o danym bloku kodu. Możesz go również użyć, aby dodać meta informacje, takie jak informacje autora, data tworzenia, zależności i więcej.

Aby utworzyć komentarze blokowe w JenkinsFile, zaczynamy od ukośnika do przodu i postaci gwiazdka (/*). Aby zamknąć komentarz blokowy, zaczynamy od gwiazdki, a następnie z ukośnym ukośnikiem (*/).

Każdy tekst umieszczony między znakami otwierającymi i zamykającymi są traktowane jako komentarze. Poniższy przykład pokazuje przykład komentarza blokowego w pliku Jenkins:

rurociąg
agent dowolny
Etapy
etap („build”)
kroki
/* Załaduj wtyczkę Zależności OWASP
… Również komentarz
… I kolejny komentarz
… Dopóki nie zamkniemy */
I f
zależnechCheck (odcinstallation: „OWASP”, dodatkowe Argumenty: '-FORMAT HTML-FORMAT XML')
zależność

Uwaga: Elipsy znaki w poprzednim kodzie są częścią komentarza i nie są wymagane do komentarza blokowego.

Komentarze Jenkinsfile Shell

W niektórych przypadkach może być konieczne wykonanie skryptu powłoki w rurociągu Jenkins. W takim przypadku możesz dodać komentarze powłoki za pomocą znaku funta (#).

Przykład:

rurociąg
agent dowolny
Etapy
etap („start”)
kroki
cii "'
CD ~
# Komentarz powłoki nawigacyjny do folderu domowego
''

Wniosek

Dowiedziałeś się o różnych rodzajach komentarzy w pliku rurociągu Jenkins. Nauczyłeś się również, jak tworzyć taki rodzaj komentarzy w Jenkinsfile i ich odpowiadające użycie.