Проверка файла рабочего процесса
Действия GitHub используют синтаксис YAML для определения рабочего процесса. Каждый рабочий процесс хранится в виде отдельного файла YAML в репозитории кода в каталоге с именем .github/workflows. Следующий пример рабочего процесса активируется при отправке кода в репозиторий. Рабочий процесс выполняет следующие действия.
- Выбирает отправленный код.
- Устанавливает Node.js.
- Устанавливает платформу тестирования автоматизированной системы тестирования Bash (Bats).
- Выполняет команду для вывода версии Bats:
bats -v.
name: learn-github-actions
run-name: ${{ github.actor }} is learning GitHub Actions
on: [push]
jobs:
check-bats-version:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '20'
- run: npm install -g bats
- run: bats -v
Общие сведения о файле рабочего процесса
Чтобы понять, как используется синтаксис YAML для создания файла рабочего процесса, в этом разделе описывается каждая строка предыдущего примера:
# Optional - The name of the workflow as it will appear in the "Actions" tab of the GitHub repository. If this field is omitted, the name of the workflow file will be used instead.
name: learn-github-actions
# Optional - The name for workflow runs generated that appear in the list of workflow runs on your repository's "Actions" tab. This example uses an expression with the 'github' context to display the username of the actor that triggered the workflow run.
run-name: ${{ github.actor }} is learning GitHub Actions
# Specifies the trigger for this workflow. This example uses the 'push' event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request.
on: [push]
# Groups together all the jobs that run in the 'learn-github-actions' workflow.
jobs:
# Defines a job named 'check-bats-version'. The child keys will define properties of the job.
check-bats-version:
# Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub.
runs-on: ubuntu-latest
# Groups together all the steps that run in the 'check-bats-version' job. Each item nested under this section is a separate action or shell script.
steps:
# The 'uses' keyword specifies that this step will run 'v4' of the 'actions/checkout' action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will use the repository's code.
- uses: actions/checkout@v4
# This step uses the 'actions/setup-node@v4' action to install the specified version of the Node.js. (This example uses version 20.) This puts both the 'node' and 'npm' commands in your PATH.
- uses: actions/setup-node@v4
with:
node-version: '20'
# The 'run' keyword tells the job to execute a command on the runner. In this case, you are using 'npm' to install the 'bats' software testing package.
- run: npm install -g bats
# The 'bats' command with a parameter that outputs the software version.
- run: bats -v
Просмотр активности для запуска рабочего процесса
При инициировании рабочего процесса создается его запуск, который выполняет этот процесс. После запуска рабочего процесса вы увидите диаграмму визуализации хода выполнения и просмотрите действие каждого шага на GitHub. Выполните следующие действия, чтобы просмотреть действие:
Перейдите на главную страницу репозитория.
Выберите действия , расположенные под именем репозитория.
На левой боковой панели выберите нужный рабочий процесс.
В списке запусков рабочего процесса выберите имя запуска, чтобы просмотреть сводку по выполнению рабочего процесса.
На левой боковой панели или в графе визуализации выберите задание, которое нужно просмотреть.
Выберите шаг для просмотра подробных результатов.
Теперь, когда вы понимаете компоненты файла рабочего процесса, вы увидите, как разработчики могут настроить файл для различных вариантов использования.