Формат и команды файла пайплайна в Gitlab

Файл пайплайна в GitLab, именуемый .gitlab-ci.yml, является конфигурационным файлом, который описывает этапы (stages), задачи (jobs), условия выполнения пайплайнов и другие настройки CI/CD. Этот файл размещается в корне репозитория и автоматически выполняется GitLab CI/CD при каждом пуше кода или других событиях.

Ниже приведен обзор формата файла .gitlab-ci.yml и основных команд, которые можно использовать.

Общая структура .gitlab-ci.yml

Основные элементы и команды файла .gitlab-ci.yml

1. stages (Этапы)
   • Этапы выполняются последовательно.
   • Каждый этап содержит набор задач, которые могут выполняться параллельно.
   • Пример:
     
     YAML

     stages: - build - test - deploy

     1 2 3 4 5

     stages:   - build   - test   - deploy

      
2. jobs (Задачи)
   • Определяются в корне файла и описывают шаги, которые будут выполнены.
   • Пример:
     
     YAML

     build-job: stage: build script: - go build -o myapp

     1 2 3 4 5

     build-job:   stage: build   script:     - go build -o myapp

      
3. script (Скрипт)
   • Это список команд, которые будут выполнены в рамках задачи.
   • Пример:
     
     YAML

     script: - go build -o myapp

     1 2 3

     script:   - go build -o myapp

      
4. artifacts (Артефакты)
   • Определяет файлы или директории, которые будут сохранены после выполнения задачи.
   • Пример:
     
     YAML

     artifacts: paths: - myapp

     1 2 3 4

     artifacts:   paths:     - myapp

      
5. variables (Переменные)
   • Можно задать глобальные переменные, которые будут доступны всем задачам.
   • Пример:
     
     YAML

     variables: GO_VERSION: "1.18"

     1 2 3

     variables:   GO_VERSION: "1.18"

      
6. before_script и after_script
   • before_script: Команды, выполняющиеся перед каждой задачей.
   • after_script: Команды, которые выполняются после всех задач.
   • Пример:
     
     YAML

     before_script: - echo "Starting CI/CD pipeline"

     1 2 3

     before_script:   - echo "Starting CI/CD pipeline"

      
7. only и except (Условия выполнения)
   • Определяет, когда должна быть выполнена задача. Например, можно указать ветку или теги.
   • Пример:
     
     YAML

     only: - main except: - tags

     1 2 3 4 5

     only:   - main except:   - tags

      
8. environment (Окружение)
   • Определяет среду для выполнения задач, например, staging или production.
   • Пример:
     
     YAML

     deploy-job: stage: deploy script: - echo "Deploying..." environment: production

     1 2 3 4 5 6

     deploy-job:   stage: deploy   script:     - echo "Deploying..."   environment: production

      
9. when (Условия запуска задачи)
   • Можно указать, когда задача должна быть выполнена: on_success, on_failure, always.
   • Пример:
     
     YAML

     test-job: stage: test script: - go test ./... when: on_failure

     1 2 3 4 5 6

     test-job:   stage: test   script:     - go test ./...   when: on_failure

      
10. retry (Повтор попытки)
    • Настраивает количество повторных попыток выполнения задачи в случае сбоя.
    • Пример:
      
      YAML

      retry: max: 3

      1 2 3

      retry:   max: 3

       

Пример простого CI/CD пайплайна для Go

Этот пайплайн будет собирать Go-приложение на этапе build, а затем запускать тесты на этапе test. Результаты тестов сохранятся в формате JUnit для дальнейшего анализа.