Шпаргалка по GitHub Actions — стандартная структура и список наиболее полезных действий

GitHub Actions — это платформа автоматизации и CI/CD внутри GitHub, предназначенная для сборки, тестирования и развертывания кода на основе событий, таких как пуши (push), запросы на слияние (pull requests) или по расписанию.

Помимо стандартного GitHub, вы можете использовать GitHub Actions на самохостинговом сервере Gitea.

Действия (Actions) охватывают официальные, общедоступные и сторонние инструменты, поддерживая автоматизацию от сборки и тестирования до развертывания, управления релизами, QA и уведомлений.

Данное краткое руководство охватывает структуру GitHub Actions, краткое описание и наиболее распространенные действия, используемые в рабочих процессах с открытым исходным кодом и коммерческих проектах. Оно является частью раздела Инструменты разработчика: Полное руководство по современным рабочим процессам.

Базовая структура конфигурации

Рабочие процессы GitHub Actions определяются в YAML-файлах, расположенных в директории .github/workflows внутри репозитория.

name: Workflow Name
on:
  push:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - name: Run tests
        run: npm test

• Блок on указывает события-триггеры.
• Каждая job выполняется на своем раннере (runner).
• steps могут выполнять команды оболочки или вызывать переиспользуемые действия.

Основные компоненты рабочего процесса

События-триггеры

• push
• pull_request
• schedule (используя синтаксис cron)
• workflow_dispatch (ручной запуск, позволяет передавать входные параметры)
• release, issue и др.

Пример:

on:
  push:
    branches: [ main ]
  workflow_dispatch:
    inputs:
      environment:
        description: 'Deployment Environment'
        required: true
        default: 'production'
        type: string

Полезные встроенные действия

Параметры действий

Общие параметры для любого вызова действия:

- name: Some Action or Step
  uses: owner/repo@ref
  with:
    param1: value
    param2: value
  env:
    ENV_VAR: value
  if: ${{ condition }}
  run: command_to_run
  shell: bash|pwsh|python|sh
  continue-on-error: true|false

• with: аргументы, передаваемые действию (см. документацию действия для всех опций)
• env: переменные окружения для шага
• if: условное выполнение
• run: команды оболочки (если не используется действие)
• shell: оболочка, используемая для выполнения шага
• continue-on-error: продолжить выполнение даже если шаг завершился ошибкой

Определение пользовательских входных данных действия

В метаданных вашего действия (action.yml):

inputs:
  example-input:
    description: 'An example input'
    required: false
    default: 'default-value'

При использовании в рабочем процессе:

- uses: my/action@v1
  with:
    example-input: 'custom-value'

Доступно как переменная окружения INPUT_EXAMPLE_INPUT при выполнении действия.

Пример: Рабочий процесс с ручными параметрами

name: Deploy
on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Deployment Environment'
        required: true
        default: 'production'
        type: string
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Deploy to environment
        run: echo "Deploying to ${{ github.event.inputs.environment }}"

Маркетплейс действий

• Тысячи переиспользуемых действий доступны в Маркетплейсе GitHub.
• Категории включают: облачные развертывания, инструменты уведомлений, фреймворки тестирования, анализ кода и многое другое.
• Изучите: actions/checkout, actions/setup-node, docker/build-push-action, actions/cache, actions/upload-artifact и многие другие.

Полезные советы

• Размещайте файлы рабочих процессов в .github/workflows.
• Используйте workflow_dispatch с inputs для ручного запуска с параметрами.
• Используйте действие cache для ускорения установки зависимостей.
• Используйте матрицу задач (matrix) для тестирования нескольких версий ОС и среды выполнения.
• Используйте секреты для конфиденциальных данных, ссылаясь на них как ${{ secrets.SECRET_NAME }}.

Данная шпаргалка охватывает основы использования, настройки и расширения GitHub Actions для автоматизации, CI/CD и других задач. Для получения дополнительной информации и обновлений всегда обращайтесь к официальной документации GitHub и репозиториям действий.

Распространенные действия GitHub Actions

Вот практический список часто используемых действий GitHub, которые помогают автоматизировать CI/CD, тестирование, сборку, развертывание и задачи рабочих процессов:

Основные официальные действия

Популярные общедоступные и сторонние действия

Действия для тестирования, QA и отчетности

Действия для развертывания и уведомлений

Утилиты и управление рабочими процессами

Как найти больше действий

Существует множество действий GitHub, которые позволяют автоматизировать рабочие процессы, такие как автоматическое тестирование, развертывание на продакшен, уведомления и интеграция с другими сервисами. В Маркетплейсе GitHub перечислены тысячи действий по категориям: тестирование, безопасность, развертывание, уведомления, качество кода и интеграции. Кураторские списки, такие как “Awesome Actions”, также отлично подходят для вдохновения и поиска.

Полезные ссылки

• https://docs.github.com/actions
• https://github.com/marketplace
• https://docs.github.com/en/actions/get-started/quickstart
• https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
• Шпаргалка по Git
• Gitea - установка и тестирование
• Резервное копирование и восстановление сервера Gitea
• Использование Gitea Actions для развертывания сайта Hugo на AWS S3
• Gitflow: Шаги, альтернативы, плюсы и минусы
• DevOps с GitOps - Argo CD, Flux, Jenkins X, Weave GitOps и другие