Como comentar em Jenkinsfile

Um Jenkinsfile pode ser escrito em uma sintaxe de oleoduto declarativo ou com script. Isso permite que Jenkins entenda as instituições e etapas que são definidas no pipeline. Podemos usar o Jenkinsfile para descrever uma ampla variedade de tarefas como compilações, testes, implantação e muito mais.

Em um Jenkinsfile, um comentário refere -se às linhas de texto que são ignoradas pelo Jenkins Pipeline Engine durante a execução. Os comentários são benéficos, pois permitem que os engenheiros do DevOps adicionem a documentação ao arquivo de pipeline.

Neste tutorial, aprenderemos como você pode criar os vários comentários em um Jenkinsfile para adicionar uma meta documentação ao seu arquivo de pipeline.

Comentários no Jenkinsfile

A sintaxe de um Jenkinsfile é baseada na linguagem de programação groovy. Isso significa que podemos usar o formato de comentário groovy para adicionar os comentários em um Jenkinsfile.

Comentários de linha única Jenkinsfile

Podemos criar os comentários de linha única em um Jenkinsfile. Esses tipos de comentários vão até o final de uma determinada linha. Os comentários de linha única são úteis para adicionar uma meta informações sobre um determinado bloco de código.

Para adicionar um comentário de linha única em um Jenkinsfile, podemos usar os dois caracteres de slash para a frente (//). Qualquer texto que seja adicionado após os caracteres até o final da linha ser tratado como comentários.

A seguir, mostra o exemplo de um comentário de linha única no Jenkinsfile:

Pipeline
agente qualquer
estágios
Stage ('Build')
passos
// Carregar o plug -in Owasp Dependence Vercher
DependencyCheck (ODCInstallation: 'Owasp', ADTTERArguments: '--formato html--formato xml')
DependencyCheckPublisher ()


// Outro comentário de linha única

Jenkinsfile Block Comentários

O segundo tipo de comentários em Jenkins são comentários em bloco. Estes são o tipo de comentário que abrange várias linhas, criando um bloco.

Os comentários do bloco são úteis para adicionar informações detalhadas sobre um determinado bloco de código. Você também pode usá -lo para adicionar uma meta informação, como informações do autor, data de criação, dependências e muito mais.

Para criar os comentários do bloco em um Jenkinsfile, começamos com uma barra para frente e um personagem de asterisco (/*). Para fechar um comentário em bloco, começamos com um asterisco seguido com uma barra para a frente (*/).

Qualquer texto colocado entre os caracteres de abertura e fechamento é tratado como comentários. O exemplo a seguir mostra o exemplo de um comentário de bloco em um arquivo Jenkins:

Pipeline
agente qualquer
estágios
Stage ('Build')
passos
/* Carregue o plugin de verificação de dependência OWASP
… Também um comentário
... e outro comentário
… Até fecharmos */
E um f
DependencyCheck (ODCInstallation: 'Owasp', ADTTERArguments: '--formato html--formato xml')
DependencyCheckPublisher ()

Nota: Os caracteres Elipses no código anterior fazem parte do comentário e não são necessários para um comentário de bloco.

Jenkinsfile Shell Comentários

Em alguns casos, pode ser necessário executar um script de shell dentro do seu pipeline Jenkins. Nesse caso, você pode adicionar os comentários do shell usando um caractere de libra (#).

Exemplo:

Pipeline
agente qualquer
estágios
estágio ('start')
passos
sh "'
CD ~
# Comentário de shell Navegando para a pasta doméstico
'"

Conclusão

Você aprendeu sobre os vários tipos de comentários no arquivo de pipeline de Jenkins. Você também aprendeu a criar esse tipo de comentário em um Jenkinsfile e seu uso correspondente.