Настройка пользовательских правил защиты развертывания

Используйте GitHub Apps для автоматизации защиты развертываний с помощью сторонних систем.

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

Пользовательские правила защиты развертывания доступны в общедоступных репозиториях для всех планов. Для доступа к пользовательским правилам защиты развертывания в частных или внутренних репозиториях необходимо использовать GitHub Enterprise.

В этой статье

Note

Пользовательские правила защиты развертывания в настоящее время находятся в beta и подвергаются изменению.

Сведения о правилах защиты пользовательских развертываний

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

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

Когда настраиваемое правило защиты развертывания активируется, оно ожидает до 30 дней ответа на событие веб-перехватчика до истечения времени ожидания и сбой задания рабочего процесса.

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

Note

Любое количество GitHub Apps, которые могут быть установлены в репозитории. Однако в любой среде одновременно можно включить не более 6 правил защиты развертывания.

Использование существующих правил защиты пользовательского развертывания

Вы можете создать собственные правила защиты развертывания или использовать все существующие правила защиты от развертывания.

Ниже приведен список официальных реализаций партнеров для правил защиты развертывания.

  • Datadog: вы можете применить правила защиты к рабочим процессам развертывания GitHub Actions с помощью мониторов Datadog. Дополнительные сведения см. в статье "Gating your GitHub Actions Deployments with Datadog Monitors in the Datadog Documentation.
  • Honeycomb: можно определить пороговые значения для отклонения или утверждения развертываний на основе данных, отправляемых в Honeycomb. Дополнительные сведения см . в приложении Honeycomb в GitHub Marketplace.
  • New Relic: дополнительные сведения см . в приложении New Relic в GitHub Marketplace.
  • NCM NodeSource: дополнительные сведения см . в приложении NCM NodeSource в GitHub Marketplace.
  • Sentry: дополнительные сведения см . в приложении Sentry Deployment Gate в GitHub Marketplace.
  • ServiceNow: дополнительные сведения см. в разделе интеграции GitHub с DevOps Change Velocity в документации По ServiceNow.

Необходимые компоненты

Чтобы пользовательское правило защиты развертывания было доступно для всех сред в репозитории, необходимо сначала установить настраиваемое правило защиты развертывания в репозитории. Дополнительные сведения см. в разделе Установка собственного приложения GitHub.

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

Включение пользовательских правил защиты развертывания для среды

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

  2. Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".

    Снимок экрана: заголовок репозитория с вкладками. Вкладка "Параметры" выделена темно-оранжевым контуром.

  3. На левой боковой панели щелкните Среды.

  4. Выберите среду, которую нужно настроить.

  5. В разделе "Правила защиты развертывания" установите флажок рядом с каждым пользовательским правилом защиты развертывания, которое необходимо включить для среды.

  6. Нажмите Сохранить правила защиты.

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