Создание шаблонов рабочих процессов для организации

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

Кто может использовать эту функцию?

Write access to the organization's public .github repository. Templates can be used by organization members who have permission to create workflows.

Примечание.

  • Так как для шаблонов рабочих процессов требуется общедоступный .github репозиторий, они недоступны для Enterprise Managed Users.
  • Чтобы избежать дублирования между шаблонами рабочих процессов, можно вызывать повторно используемые рабочие процессы из рабочего процесса. Это позволяет упростить обслуживание рабочих процессов. Дополнительные сведения см. в разделе Повторное использование рабочих процессов.

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

  1. Если он еще не существует, создайте новый общедоступный репозиторий с именем .github в вашей организации.

  2. Создайте каталог с именем workflow-templates.

  3. Создайте новый файл рабочего процесса в каталоге workflow-templates.

    Если необходимо сослаться на ветвь репозитория по умолчанию, можно использовать заполнитель $default-branch. При создании рабочего процесса этот заполнитель автоматически заменяется именем ветви по умолчанию репозитория.

    Например, этот файл с именем octo-organization-ci.yml демонстрирует базовый рабочий процесс.

    YAML
    name: Octo Organization CI

on:
  push:
    branches: [ $default-branch ]
  pull_request:
    branches: [ $default-branch ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Run a one-line script
        run: echo Hello from Octo Organization

  4. Создайте файл метаданных в каталоге workflow-templates. Файл метаданных должен иметь то же имя, что и файл рабочего процесса, однако вместо расширения .yml должно быть добавлено .properties.json. Например, файл с именем octo-organization-ci.properties.json содержит метаданные для файла рабочего процесса с именем octo-organization-ci.yml.

    JSON
    {
    "name": "Octo Organization Workflow",
    "description": "Octo Organization CI workflow template.",
    "iconName": "example-icon",
    "categories": [
        "Go"
    ],
    "filePatterns": [
        "package.json$",
        "^Dockerfile",
        ".*\\.md$"
    ]
}

    • name - Необходимые. Имя рабочего процесса. Отображается в списке доступных рабочих процессов.

    • description - Необходимые. Описание рабочего процесса. Отображается в списке доступных рабочих процессов.

    • iconName - Необязательно. Указывает значок рабочего процесса, отображаемого в списке рабочих процессов. iconName может быть один из следующих типов:

      • ФАЙЛ SVG, хранящийся в каталоге workflow-templates . Чтобы ссылаться на файл, значение должно быть именем файла без расширения файла. Например, на файл SVG с именем example-icon.svg будет даваться ссылка example-icon.
      • Значок из набора данных GitHubнабора Octicons. Чтобы ссылаться на октикон, значение должно быть octicon <icon name>. Например, octicon smiley.

    • categories - Необязательно. Определяет категории, в которые отображается рабочий процесс. Имена категорий можно использовать из следующих списков:

    • filePatterns - Необязательно. Позволяет использовать рабочий процесс, если репозиторий пользователя содержит файл в корневом каталоге, соответствующий определенному регулярному выражению.

Чтобы добавить другой шаблон рабочего процесса, добавьте файлы в тот же workflow-templates каталог.

Следующие шаги

Дополнительные сведения о GitHub Actionsсм. в разделе Использование шаблонов рабочих процессов.