Перевірка файлу робочого циклу

Завершено

Дії GitHub використовують синтаксис YAML для визначення робочого циклу. Кожен робочий цикл зберігається як окремий файл YAML у сховищі коду в каталозі з іменем .github/workflows. Наведений нижче приклад робочого циклу запускається щоразу, коли код передається до сховища. Робочий цикл виконує такі дії:

1. Перевіряє відштовхнутий код.
2. Інсталює Node.js.
3. Інсталює систему автоматичного тестування Bash (Bats).
4. Виконує команду для виведення версії 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. Щоб переглянути дії, виконайте такі дії:

1. Перейдіть до головної сторінки сховища.

2. Виберіть Дії, розташовано під іменем сховища.

3. На лівій бічній панелі виберіть робочий цикл, який потрібно переглянути.

4. У списку запущених робочих циклів виберіть ім'я запуску, щоб переглянути зведення запуску робочого циклу.

5. На лівій бічній панелі або графіку візуалізації виберіть завдання, яке потрібно переглянути.

6. Виберіть крок, щоб переглянути докладні результати.

Тепер, коли ви розумієте компоненти файлу робочого циклу, ви можете побачити, як розробники можуть налаштувати файл для різних випадків використання.