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

Обзор

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

GitHub предоставляет готовые к использованию начальные рабочие процессы для следующих высокоуровневых категорий:

• Непрерывное развертывание (CD) . Дополнительные сведения см. в разделе Сведения о непрерывном развертывании.

• Непрерывная интеграция (CI) . Дополнительные сведения см. в разделе Сведения о непрерывной интеграции.

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

Создание начального рабочего процесса

Начальные рабочие процессы могут создаваться пользователями с доступом на запись в репозиторий .github организации. Затем их могут использовать члены организации, имеющие разрешение на создание рабочих процессов.

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

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@v3
   
         - 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 starter workflow.",
       "iconName": "example-icon",
       "categories": [
           "Go"
       ],
       "filePatterns": [
           "package.json$",
           "^Dockerfile",
           ".*\\.md$"
       ]
   }

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

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

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

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

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

     • Общие имена категорий из репозитория starter-workflows .
     • Linguist языки из списка в репозитории лингвистов.
     • Поддерживаемые технические стеки из списка в репозитории starter-workflows .

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

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

Дальнейшие действия

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