Required workflows

Общие сведения

Вы можете настроить рабочий процесс, который должен выполняться в репозиториях организации для всех запросов на вытягивание, открытых в ветви по умолчанию. Необходимые рабочие процессы позволяют реализовать политики CI/CD для всей организации, которые применяются к текущим и будущим репозиториям. Требуемый рабочий процесс активируется событиями запроса на вытягивание и отображается как обязательная проверка состояния, которая блокирует возможность объединения запроса на вытягивание до тех пор, пока требуемый рабочий процесс не завершится успешно.

Обязательные рабочие процессы не совпадают с рабочими процессами для повторного использования. Повторно используемые рабочие процессы могут вызываться другим рабочим процессом. Требуемые рабочие процессы применяются в репозиториях владельцем организации.

Предварительные требования

Перед настройкой требуемого рабочего процесса обратите внимание на следующие предварительные требования.

• GitHub Actions должен быть включен для репозитория в параметрах организации, чтобы выполнять необходимые рабочие процессы. После включения на уровне организации необходимые рабочие процессы будут запускаться, даже если GitHub Actions отключен в параметрах репозитория. Дополнительные сведения об управлении GitHub Actions в репозиториях организации см. в разделе Disabling or limiting GitHub Actions for your organization.
• Необходимые рабочие процессы доступны для организаций и только в репозиториях, где план организации поддерживает необходимые проверки состояния. Если необходимые проверки состояния не поддерживаются, рабочий процесс по-прежнему будет выполняться, но он не будет обязательной проверкой и не будет блокировать слияние. Дополнительные сведения о поддержке обязательных проверок состояния см. в разделе About protected branches.
• Ветвь репозитория по умолчанию должна соответствовать параметру ветви по умолчанию организации, чтобы требуемые рабочие процессы запускались в качестве обязательных проверок состояния. Если имена ветвей по умолчанию не совпадают, рабочий процесс по-прежнему будет выполняться, но проверка не будет обязательной. Дополнительные сведения об управлении именами ветвей по умолчанию см. в разделах Managing the default branch name for repositories in your organization и Changing the default branch.
• Для выполнения необходимых рабочих процессов исходный репозиторий запроса на вытягивание должен находиться в той же организации, что и целевой репозиторий. GitHub будет истоком требуемого рабочего процесса из фиксации HEAD ветви по умолчанию из репозитория, содержащего рабочий процесс.
• Секреты, используемые в требуемом рабочем процессе, должны создаваться на уровне организации или в целевых репозиториях.
• Секреты в исходном репозитории не будут извлекаться при выполнении рабочего процесса в целевом репозитории.

Ограничения и поведение для исходного репозитория

Обратите внимание на следующие ограничения и поведение для исходного репозитория и рабочего процесса.

• Требуемые рабочие процессы могут храниться в любой папке репозитория и не ограничены папкой .github/workflows , как обычные рабочие процессы. Если требуемый рабочий процесс вызывает повторно используемый рабочий процесс, повторно используемый рабочий процесс должен храниться в папке .github/workflows . При вызове повторно используемого рабочего процесса обязательный рабочий процесс должен использовать полный путь и ссылку на повторно используемый рабочий процесс. Например, {owner}/{repo}/.github/workflows/{filename}@{ref}.
• Если требуемый рабочий процесс содержится в частном репозитории , необходимо убедиться, что рабочие процессы в репозитории доступны другим репозиториям в вашей организации. Дополнительные сведения см. в разделах Managing GitHub Actions settings for a repository.
• Рабочие процессы, хранящиеся в общедоступном репозитории, можно настроить в качестве необходимых рабочих процессов для любого репозитория в организации. Рабочие процессы, хранящиеся в частном репозитории, можно настроить только как необходимые рабочие процессы для других частных репозиториев в вашей организации.
• CodeQL не поддерживается в требуемых рабочих процессах, так как CodeQL требует настройки на уровне репозитория. Сведения о настройке сканирования кода см. в разделе Configuring code scanning for a repository.

Ограничения и поведение для целевого репозитория

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

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

Просмотр выполнений рабочих процессов для необходимых рабочих процессов

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

1. На GitHub.com перейдите на главную страницу репозитория. 1. Щелкните Действия под именем репозитория.

2. На левой боковой панели можно просмотреть запуски рабочих процессов для обязательных рабочих процессов в разделе "Обязательные рабочие процессы".

   

Добавление требуемого рабочего процесса в организацию

Владельцы организации могут настраивать необходимые рабочие процессы в своей организации. Дополнительные сведения см. в разделе Disabling or limiting GitHub Actions for your organization.