Cómo comentar en Jenkinsfile
Un Jenkinsfile se puede escribir en una sintaxis de tubería declarativa o con guión. Esto permite a Jenkins comprender las instituciones y los pasos que se definen en la tubería. Podemos usar el Jenkinsfile para describir una amplia variedad de tareas, como compilaciones, pruebas, implementación y más.
En un Jenkinsfile, un comentario se refiere a las líneas de texto que son ignoradas por el motor de tuberías de Jenkins durante la ejecución. Los comentarios son beneficiosos, ya que permiten a los ingenieros de DevOps agregar la documentación al archivo de la tubería.
En este tutorial, aprenderemos cómo puede crear los diversos comentarios en un Jenkinsfile para agregar una meta documentación a su archivo de tubería.
Comentarios en Jenkinsfile
La sintaxis de un Jenkinsfile se basa en el lenguaje de programación maravilloso. Esto significa que podemos usar el formato de comentarios Groovy para agregar los comentarios en Jenkinsfile.
Comentarios de una sola línea de Jenkinsfile
Podemos crear los comentarios de una sola línea en un jenkinsfile. Estos tipos de comentarios abarcan al final de una línea dada. Los comentarios de una sola línea son útiles para agregar una meta información sobre un bloque de código determinado.
Para agregar un comentario de una sola línea en un Jenkinsfile, podemos usar los dos caracteres de barra de barra (//). Cualquier texto que se agregue después de los caracteres hasta que se trate el final de la línea como comentarios.
Lo siguiente muestra el ejemplo de un comentario de una sola línea en Jenkinsfile:
tubería
agente cualquiera
etapas
etapa ('construir')
pasos
// Cargue el complemento de verificador de dependencia OWASP
DependencyCheck (ODCInstallation: 'Owasp', Addemarguments: '--Format HTML --Format XML')
DependencyCheckPublisher ()
// Otro comentario de una sola línea
Comentarios de bloque de jenkinsfile
El segundo tipo de comentarios en Jenkins son los comentarios de bloque. Estos son el tipo de comentarios que abarcan múltiples líneas que crean un bloque.
Los comentarios del bloque son útiles para agregar una información detallada sobre un bloque de código determinado. También puede usarlo para agregar una meta información, como información del autor, fecha de creación, dependencias y más.
Para crear los comentarios en el bloque en un Jenkinsfile, comenzamos con una barra de barra y un carácter de asterisco (/*). Para cerrar un comentario en bloque, comenzamos con un asterisco seguido con una barra de avance (*/).
Cualquier texto que se coloque entre los caracteres de apertura y cierre se trate como comentarios. El siguiente ejemplo muestra el ejemplo de un comentario de bloque en un archivo de Jenkins:
tubería
agente cualquiera
etapas
etapa ('construir')
pasos
/* Cargar el complemento de verificación de dependencia de OWASP
... también un comentario
... y otro comentario
... hasta que cerremos */
Y una F
DependencyCheck (ODCInstallation: 'Owasp', Addemarguments: '--Format HTML --Format XML')
DependencyCheckPublisher ()
Nota: Los caracteres de elipses en el código anterior son parte del comentario y no son necesarios para un comentario en bloque.
Comentarios de Jenkinsfile Shell
En algunos casos, es posible que deba ejecutar un script de shell dentro de su tubería Jenkins. En tal caso, puede agregar los comentarios de shell usando un personaje de libra (#).
Ejemplo:
tubería
agente cualquiera
etapas
etapa ('inicio')
pasos
sh "''
CD ~
# comentario de shell navegando a la carpeta de inicio
"
Conclusión
Aprendiste sobre los diversos tipos de comentarios en el archivo de tubería de Jenkins. También aprendió a crear este tipo de comentarios en un Jenkinsfile y su uso correspondiente.