GitHub Actions. Общие сведения

• GitHub Actions. Общие сведения (данная статья)
• GitHub Actions. Дополнительные возможности

GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline.

— GitHub Docs

• name– имя workflow, отображаемое на вкладке Actions репозитория GitHub. Если не задать, то будет соответствовать пути файла конфигурации относительно корня репозитория;
• run-name – имя каждого запуска workflow, отображаемое в перечне всех запусков на вкладке Actions репозитория GitHub. Если не задать, то будет содержать информацию, зависящую от события.

1. Возникает event, который соответствует действию. Данный event будет ассоциироваться с хэшем коммита (SHA) и git ref;
2. GitHub ищет папку с конфигурациями для workflow в коммите репозитория, который соответствует коммиту ассоциированному с event;
3. GitHub запускает все workflow, в конфигурации которых есть свойство on со значениями, соответствующими event.

1. Примитивная форма (единственное событие):

on: push

2. Форма массива (одно или более событие):

on: [push, fork]

3. Объектная форма:

on:
  label:
  push:

on:
  issues:
    types:
      - opened

on:
  push:
    branches:
      - master

jobs:
  my_first_job:
    name: My first job
  my_second_job:
    name: My second job

jobs:
  job1:
  job2:
    needs: job1

• windows-latest
• ubuntu-latest
• macos-latest

jobs:
  example_matrix:
    strategy:
      matrix:
        version: [10, 12, 14]
        os: [ubuntu-latest, windows-latest]

strategy:
  matrix:
    os: [macos-latest, windows-latest]
    version: [12, 14, 16]
    exclude:
      - os: macos-latest
        version: 12

jobs:
  example_job:
    steps:

steps:
  - name: Clean temp directory
    run: rm -rf *
    working-directory: ./temp

steps:
  - name: Clean install dependencies and build
    run: |
      npm ci
      npm run build

steps:
  - name: Checkout repository
    uses: actions/checkout@v3

jobs:
  my_first_job:
    steps:
      - name: My first step
        uses: actions/hello_world@main
        with:
          first_name: Mona
          middle_name: The
          last_name: Octocat

name: Show env
on: workflow_dispatch
env:
  WORKFLOW_ENV: wf
jobs:
  show_env_job:
    runs-on: ubuntu-latest
    env:
      JOB_ENV: job
    steps:
      - run: echo "$WORKFLOW_ENV --- $JOB_ENV --- $STEP_ENV"
        env:
          STEP_ENV: step

1. Создадим пустой приватный репозиторий;
2. Создадим файл workflow.yml в папке .github/workflows/ созданного репозитория;
3. Зададим имя workflow: Test workflow;

name: Test workflow

4. Для event, который запустит workflow, выберем workflow_dispatch. Данный event позволяет запускать процесс вручную;

on: workflow_dispatch

5. Определим один job под названием test и именем Test workflow job;

jobs:
  test:
    name: Test workflow job

6. Укажем, что хотим запустить наш workflow на базе ОС Ubuntu по матричной стратегии с двумя версиями Node.js: 14 и 16;

jobs:
  test:
    name: Test workflow job
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [ 14, 16 ]

7. Определим два step:
   • Использование action для установки определенной в матрице версии Node.js;
   • Использование команды в оболочке для демонстрации версии установленного Node.js;

steps:
  - name: Setup Node.js environment
    uses: actions/setup-node@v3.6.0
    with:
      node-version: ${{ matrix.node-version }}
  - name: Test Node.js
    run: node --version

8. Сохраним конфигурационный файл и перейдем на вкладку Actions репозитория;
9. Выберем тестовый workflow;

10. Запустим тестовый workflow, немного подождем и обновим страничку;

11. Перейдем в детали workflow, убедимся, что было выполнено 2 job, в каждом из которых присутствует step: Test Node.js. В деталях каждого step будет видно, что установлены 2 разные версии Node.js.

• https://docs.github.com/en/actions — документация платформы GitHub Actions
• https://github.com/marketplace?type=actions — маркетплейс Actions для создаваемых workflow