Wie man in Jenkinsfile kommentiert

Eine JenkinsFile kann in eine deklarative oder geschriebene Pipeline -Syntax geschrieben werden. Auf diese Weise können Jenkins die Institutionen und Schritte verstehen, die in der Pipeline definiert sind. Wir können die JenkinsFile verwenden, um eine Vielzahl von Aufgaben wie Builds, Tests, Bereitstellungen und mehr zu beschreiben.

In einer JenkinsFile bezieht sich ein Kommentar auf die Textzeilen, die von der Jenkins -Pipeline -Engine während der Ausführung ignoriert werden. Kommentare sind von Vorteil, da die DevOps -Ingenieure die Dokumentation zur Pipeline -Datei hinzufügen können.

In diesem Tutorial erfahren wir, wie Sie die verschiedenen Kommentare in einer Jenkinsfile erstellen können, um Ihrer Pipeline -Datei eine Meta -Dokumentation hinzuzufügen.

Kommentare in Jenkinsfile

Die Syntax einer JenkinsFile basiert auf der groovigen Programmiersprache. Dies bedeutet, dass wir das groovige Kommentarformat verwenden können, um die Kommentare in einer Jenkins -Datei hinzuzufügen.

JenkinsFile-Einzellinien-Kommentare

Wir können die Einzellinien-Kommentare in einer Jenkinsfile erstellen. Diese Art von Kommentaren erstrecken sich bis zum Ende einer bestimmten Zeile. Die Einzelzeilen-Kommentare sind nützlich, um eine Meta-Informationen zu einem bestimmten Codeblock hinzuzufügen.

Um einen einzelnen Kommentar in einem JenkinsFile hinzuzufügen, können wir die beiden Stürmer-Slash-Zeichen verwenden (//). Jeder Text, der nach den Zeichen bis zum Ende der Zeile hinzugefügt wird, wird als Kommentare behandelt.

Das Folgende zeigt das Beispiel eines einzelnen Kommentars in JenkinsFile:

Pipeline
Agent jeder
Stufen
Stage ('Build')
Schritte
// Laden Sie das OWASP -Abhängigkeitsprüfungsplugin
Abhängigkeitscheck (Odcinstallation: 'Owasp', zusätzliche ARGUMENTEN: '-Format HTML-Format XML')
Abhängigkeitscheckpublisher ()


// Ein weiterer Einzelantrags-Kommentar

JenkinsFile Block Kommentare

Die zweite Art von Kommentaren in Jenkins sind Blockkommentare. Dies sind die Art von Kommentaren, die mehrere Zeilen erstellen, die einen Block erstellen.

Block Kommentare sind nützlich, um detaillierte Informationen zu einem bestimmten Codeblock hinzuzufügen. Sie können es auch verwenden, um Meta -Informationen wie Autoreninformationen, Erstellungsdatum, Abhängigkeiten und mehr hinzuzufügen.

Um die Blockkommentare in einer Jenkinsfile zu erstellen, beginnen wir mit einem Vorwärts -Schrägstrich und einem Sternchen (/*). Um einen Blockkommentar zu schließen, beginnen wir mit einem Sternchen mit einem Vorwärtsstrahl (*/).

Jeder Text, der zwischen den Öffnungs- und Schlussfiguren platziert wird, werden als Kommentare behandelt. Das folgende Beispiel zeigt das Beispiel eines Block -Kommentars in einer Jenkins -Datei:

Pipeline
Agent jeder
Stufen
Stage ('Build')
Schritte
/* Laden Sie das OWASP -Abhängigkeitsprüfungs -Plugin
… Auch ein Kommentar
… Und ein weiterer Kommentar
… Bis wir schließen */
Und a f
Abhängigkeitscheck (Odcinstallation: 'Owasp', zusätzliche ARGUMENTEN: '-Format HTML-Format XML')
Abhängigkeitscheckpublisher ()

Hinweis: Die Elipses -Zeichen im vorherigen Code sind Teil des Kommentars und sind für einen Blockkommentar nicht erforderlich.

Jenkinsfile Shell kommentiert

In einigen Fällen müssen Sie möglicherweise ein Shell -Skript in Ihrer Jenkins -Pipeline ausführen. In einem solchen Fall können Sie die Shell -Kommentare mit einem Pfundzeichen (#) hinzufügen.

Beispiel:

Pipeline
Agent jeder
Stufen
Stage ('Start')
Schritte
Sch "'
CD ~
# Shell -Kommentar, der zum Home -Ordner navigiert
'"

Abschluss

Sie haben die verschiedenen Arten von Kommentaren in der Jenkins -Pipeline -Datei erfahren. Sie haben auch gelernt, wie man eine Art von Kommentaren in einer Jenkinsfile und ihrer entsprechenden Verwendung erstellt.