Comment commenter dans Jenkinsfile

Un JenkinsFile peut être écrit dans une syntaxe de pipeline déclarative ou scénarisée. Cela permet à Jenkins de comprendre les institutions et les étapes définies dans le pipeline. Nous pouvons utiliser le JenkinsFile pour décrire une grande variété de tâches telles que les builds, les tests, le déploiement, et plus.

Dans un JenkinsFile, un commentaire fait référence aux lignes de texte qui sont ignorées par le moteur du pipeline Jenkins pendant l'exécution. Les commentaires sont bénéfiques car ils permettent aux ingénieurs DevOps d'ajouter la documentation au fichier du pipeline.

Dans ce didacticiel, nous apprendrons comment créer les différents commentaires dans un JenkinsFile pour ajouter une méta-documentation à votre fichier de pipeline.

Commentaires dans Jenkinsfile

La syntaxe d'un Jenkinsfile est basée sur le langage de programmation groovy. Cela signifie que nous pouvons utiliser le format de commentaire Groovy pour ajouter les commentaires dans un Jenkinsfile.

Commentaires en ligne unique JenkinsFile

Nous pouvons créer les commentaires d'une seule ligne dans un Jenkinsfile. Ces types de commentaires s'étendent à la fin d'une ligne donnée. Les commentaires en une seule ligne sont utiles pour ajouter une méta-information sur un bloc de code donné.

Pour ajouter un commentaire à une seule ligne dans un JenkinsFile, nous pouvons utiliser les deux caractères Slash Forward (//). Tout texte qui est ajouté après les caractères jusqu'à la fin de la ligne est traité comme des commentaires.

Ce qui suit montre l'exemple d'un commentaire à une seule ligne dans Jenkinsfile:

pipeline
agent
étapes
étape ('build')
pas
// Chargez le plugin de vérificateur de dépendance OWASP
DependencyCheck (Odcinstallation: «Owasp», AdditionalArguments: «- Format HTML - Format XML»)
DependencyCheckPublisher ()


// un autre commentaire à une seule ligne

Commentaires de blocs Jenkinsfile

Le deuxième type de commentaires dans Jenkins est le bloc des commentaires. Ce sont le type de commentaires qui s'étendent sur plusieurs lignes créant un bloc.

Les commentaires du bloc sont utiles pour ajouter des informations détaillées sur un bloc de code donné. Vous pouvez également l'utiliser pour ajouter une méta-information telle que les informations sur l'auteur, la date de création, les dépendances, et plus.

Pour créer les commentaires du bloc dans un JenkinsFile, nous commençons par une barre de barre avant et un caractère astérisque (/ *). Pour fermer un commentaire de bloc, nous commençons par un astérisque suivi avec une barre oblique (* /).

Tout texte placé entre les caractères d'ouverture et de clôture est traité comme des commentaires. L'exemple suivant montre l'exemple d'un commentaire de bloc dans un fichier Jenkins:

pipeline
agent
étapes
étape ('build')
pas
/ * Chargez le plugin de contrôle de dépendance OWASP
… Aussi un commentaire
… Et un autre commentaire
… Jusqu'à ce que nous fermons * /
Et un f
DependencyCheck (Odcinstallation: «Owasp», AdditionalArguments: «- Format HTML - Format XML»)
DependencyCheckPublisher ()

Remarque: Les caractères Elipses du code précédent font partie du commentaire et ne sont pas requis pour un commentaire de blocage.

Commentaires de shell Jenkinsfile

Dans certains cas, vous devrez peut-être exécuter un script shell à l'intérieur de votre pipeline Jenkins. Dans un tel cas, vous pouvez ajouter les commentaires de Shell en utilisant un caractère de livre (#).

Exemple:

pipeline
agent
étapes
étape ('start')
pas
sh "'
CD ~
# commentaire de shell naviguant vers le dossier à domicile
'"

Conclusion

Vous avez appris les différents types de commentaires dans le fichier de pipeline Jenkins. Vous avez également appris à créer un tel type de commentaires dans un JenkinsFile et leur utilisation correspondante.