Использование стандартных блоков в рабочем процессе

Добавление действия из того же репозитория

Если действие определено в том же репозитории, в котором оно используется в файле рабочего процесса, можно сослаться на действие с помощью синтаксиса {owner}/{repo}@{ref} или ./path/to/dir в файле рабочего процесса.

Пример структуры файла репозитория:

|-- hello-world (repository)
|   |__ .github
|       └── workflows
|           └── my-first-workflow.yml
|       └── actions
|           |__ hello-world-action
|               └── action.yml

Путь является относительным (./) к рабочему каталогу по умолчанию (github.workspace, $GITHUB_WORKSPACE). Если действие извлекает репозиторий в расположение, отличное от рабочего процесса, необходимо обновить относительный путь, используемый для локальных действий.

Пример файла рабочего процесса:

jobs:
  my_first_job:
    runs-on: ubuntu-latest
    steps:
      # This step checks out a copy of your repository.
      - name: My first step - check out repository
        uses: actions/checkout@v6
      # This step references the directory that contains the action.
      - name: Use local hello-world-action
        uses: ./.github/actions/hello-world-action

Файл action.yml применяется для предоставления метаданных для действия. Узнайте о содержимом этого файла в Справочник по синтаксису метаданных.

Добавление действия из другого репозитория

Если действие определено не в том же репозитории, где находится файл рабочего процесса, сослаться на действие можно с помощью синтаксиса {owner}/{repo}@{ref} в файле рабочего процесса.

Действие должно храниться в общедоступный репозиторий или внутренний репозиторий, настроенный для разрешения доступа к рабочим процессам. Дополнительные сведения см. в разделе Совместное использование действий и рабочих процессов с вашим предприятием.

jobs:
  my_first_job:
    steps:
      - name: My first step
        uses: actions/setup-node@v4

Если , владелец предприятия включил доступ к действиям в GitHub.com, этот синтаксис можно использовать для ссылки на действия в пределах предприятия или на GitHub.com. GitHub Actions сначала будет искать действие в организации, а затем вернуться к GitHub.com.

Ссылка на контейнер на Docker Hub

Если действие определено в опубликованном изображении контейнера Docker на Docker Hub, вы должны ссылаться на действие синтаксисом docker://{image}:{tag} в вашем рабочем процессе. Для защиты вашего кода и данных мы настоятельно рекомендуем проверить целостность образа контейнера Docker из Docker Hub перед использованием его в вашем рабочем процессе.

jobs:
  my_first_job:
    steps:
      - name: My first step
        uses: docker://alpine:3.8

Примеры действий Docker см. в разделе Docker-image.yml рабочий процесс и Создание действия контейнера Docker.

Защита безопасности для использования действий в рабочих процессах

GitHub предоставляет функции безопасности, которые можно использовать для повышения безопасности рабочих процессов. Встроенные функции %% данных variables.product.prodname_dotcom %}позволяют получать уведомления об уязвимостях в используемых действиях или автоматизировать процесс поддержания действий в рабочих процессах. Дополнительные сведения см. в разделе Справочник по безопасному использованию.

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

Создатели действия сообщества могут использовать теги, ветви или значения SHA для управления выпусками действия. Как и в случае с любой зависимостью, следует указать версию действия, которую необходимо использовать, в зависимости от того, насколько приемлемо автоматическое принятие изменений действия.

Версия действия указывается в файле рабочего процесса. Узнать, какой подход к управлению выпусками применяется и какой тег, ветвь или значение SHA следует использовать, можно в документации по действию.

Использование тегов

Теги помогают решить, когда следует переключаться между основными и дополнительными версиями, но они являются временными и могут перемещаться или удаляться ответственным лицом. В этом примере показано, как нацелиться на действие, помеченное как v1.0.1:

steps:
  - uses: actions/javascript-action@v1.0.1

Использование значений SHA

Если требуется более надежное управление версиями, следует использовать значение SHA, связанное с версией действия. Значения SHA являются неизменяемыми и, следовательно, более надежными, чем теги или ветви. Однако этот подход означает, что вы не будете автоматически получать обновления для действия, включая важные исправления ошибок и обновления системы безопасности. Необходимо использовать полное значение SHA фиксации, а не сокращенное. При выборе SHA необходимо убедиться, что он находится в репозитории действия, а не вилке репозитория. Этот пример предназначен для SHA действия:

steps:
  - uses: actions/javascript-action@a824008085750b8e136effc585c3cd6082bd575f

Использование ветвей

Указание целевой ветви для действия означает, что всегда будет использоваться версия в этой ветви. Этот подход может вызвать проблемы, если обновление ветви включает критические изменения. В этом примере используется ветвь с именем @main:

steps:
  - uses: actions/javascript-action@main

Дополнительные сведения см. в разделе Сведения о настраиваемых действиях.

Использование входных и выходных данных с действием

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

Чтобы просмотреть входные и выходные данные действия, проверьте action.yml корневой каталог репозитория.

В этом примере файла action.yml ключевое слово inputs определяет обязательные входные данные file-path и включает значение по умолчанию, которое будет использоваться, если значение не указано. Ключевое слово outputs определяет выходные данные results-file, то есть файл с результатами.

name: "Example"
description: "Receives file and generates output"
inputs:
  file-path: # id of input
    description: "Path to test script"
    required: true
    default: "test-file.js"
outputs:
  results-file: # id of output
    description: "Path to results file"