Перейти к основному содержимому

Комментарии в Jenkinsfile

· 2 мин. чтения

1. Обзор​

В этом уроке мы увидим, как мы можем использовать комментарии в Jenkinsfile . Мы рассмотрим различные типы комментариев и их синтаксис.

2. Комментарии в Jenkinsfile​

Синтаксис Jenkinsfile основан на Groovy, поэтому для комментариев можно использовать синтаксис Groovy . Давайте возьмем простой пример Pipeline Linter и попробуем его закомментировать.

2.1. Однострочные комментарии​

Однострочные комментарии в Jenkinsfile такие же, как в популярных языках, таких как Java, C++ и C# .

Они начинаются с двух косых черт ( // ). Любой текст между // и концом строки комментируется и игнорируется в Jenkinsfile .

Давайте воспользуемся однострочными комментариями, чтобы закомментировать базовое определение конвейера:

//pipeline {
//    agent any
//    stages {
//        stage('Initialize') {
//            steps {
//                echo 'Hello World'
//            }
//        }
//    }
//}

2.2. Блокировать комментарии​

Блочные комментарии в Jenkinsfile используются для комментирования блока кода. Опять же, шаблон похож на Java и C++.

Блочный комментарий начинается с косой черты, за которой следует звездочка (/), и заканчивается звездочкой, за которой следует косая черта (/) . Начальный (/) и конечный (/) символы будут добавлены в соответствующие места, чтобы пометить выбранный блок как комментарий.

В этом примере мы будем использовать блочные комментарии, чтобы закомментировать определение конвейера:

/*
pipeline {
    agent any
    stages {
        stage('Initialize') {
            steps {
                echo 'Placeholder.'
            }
        }
    }
}
*/

2.3. Комментарии в сценарии оболочки​

Находясь внутри раздела оболочки (sh) , мы будем использовать символ комментария оболочки, решетку (#) , для комментирования:

pipeline {
    agent any
    stages {
        stage('Initialize') {
            steps {
                sh '''
                cd myFolder
                # This is a comment in sh & I am changing the directory to myFolder
                '''
            }
        }
    }
}

3. Заключение​

В этой короткой статье мы рассмотрели различные типы комментариев в Jenkinsfile . Сначала мы рассмотрели однострочные комментарии. Далее мы увидели, как использовать блочные комментарии. Наконец, мы показали, как добавлять комментарии в раздел оболочки Jenkinsfile .