Skip to main content

Управление наборами правил для репозитория

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

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

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

Наборы правил доступны в общедоступных репозиториях с GitHub Free и GitHub Free для организаций, а также в общедоступных и частных репозиториях с GitHub Pro, GitHub Teamи GitHub Enterprise Cloud. Дополнительные сведения см. в разделе Планы GitHub.

Наборы правил push-уведомлений доступны для плана GitHub Enterprise Cloud во внутренних и частных репозиториях, вилках репозиториев с включенными наборами push-правил и организациями в организации.

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

Для управления наборами правил можно использовать ИНТЕРФЕЙСы API REST и GraphQL. Дополнительные сведения см. в разделе [AUTOTITLE и Конечные точки REST API для правил](/graphql/reference/mutations#createrepositoryruleset).

Совет

Если вы являетесь владельцем организации, можно создать наборы правил на уровне организации. Эти наборы правил можно применять к определенным репозиториям в организации, а также к конкретным ветвям в этих репозиториях. Дополнительные сведения см. в разделе Создание наборов правил для репозиториев в организации.

Просмотр наборов правил для репозитория

На странице «Наборы правил» любой, кто имеет доступ к репозиторию, может просматривать активные наборы правил, направленные на определённую ветку, тег или ограничение

          Также вы увидите, что наборы правил работают в режиме «Оценить», которые не применяются.

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

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

  2. В представлении дерева файлов слева выберите раскрывающееся меню "git-branch" aria-hidden="true" aria-label="git-branch" %} в раскрывающемся меню "git-branch" %} и выберите команду Просмотреть все ветви. Вы также можете найти раскрывающееся меню ветви в верхней части интегрированного редактора файлов.

    Снимок экрана: представление дерева файлов для репозитория. Раскрывающееся меню для ветвей развернуто и описано в темно-оранжевый цвет.

  3. Слева от названия ветки нажмите .

    Совет

    Только ветки с набором правил имеют иконку рядом с названием.

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

  5. Щелкните имя набора правил, который вы хотите просмотреть.

Кроме того, можно просмотреть активные русели:

  • /rules Добавив slug в URL-адрес репозитория. Например, чтобы просмотреть правила репозитория документации открытый код по адресу GitHub, перейдите в https://github.com/github/docs/rules.

  • В поле слияния, если есть правила, блокирующие слияние запроса на вытягивание.

Изменение набора правил

Примечание.

Если набор правил был создан на уровне организации, невозможно изменить набор правил из параметров репозитория. Если у вас есть разрешение на изменение набора правил, это можно сделать в параметрах организации. Дополнительные сведения см. в разделе Управление наборами правил для репозиториев в организации.

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

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

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

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

  3. В левой боковой панели в разделе "Код и автоматизация" щелкните "Правила", а затем щелкните "Наборы правил".

    Снимок экрана: боковая панель страницы "Параметры" для репозитория. Вложенное меню "Правила" развернуто, а параметр "Наборы правил" описан оранжевым цветом.

  4. На странице "Наборы правил" щелкните имя набора правил, который требуется изменить.

  5. Измените набор правил по мере необходимости. Сведения о доступных правилах см. в разделе Доступные правила для наборов правил.

  6. В нижней части страницы нажмите кнопку Сохранить изменения.

Удаление набора правил

Совет

Если вы хотите временно отключить набор правил, но не хотите его удалить, можно задать для набора правил значение "Отключено". Дополнительные сведения см. в разделе "Редактирование набора правил".

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

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

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

  3. В левой боковой панели в разделе "Код и автоматизация" щелкните "Правила", а затем щелкните "Наборы правил".

    Снимок экрана: боковая панель страницы "Параметры" для репозитория. Вложенное меню "Правила" развернуто, а параметр "Наборы правил" описан оранжевым цветом.

  4. Щелкните имя набора правил, который вы хотите удалить.

  5. Справа от имени набора правил выберите , а затем выберите Удалить набор правил.

    Снимок экрана: страница редактирования набора правил. Под кнопкой, помеченной тремя точками, параметр с меткой "Удалить набор правил" описывается оранжевым цветом.

Использование журнала наборов правил

Журнал набора правил выводит события, активированные изменениями, влияющими на наборы правил за последние 180 дней.

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

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

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

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

  3. В левой боковой панели в разделе "Код и автоматизация" щелкните "Правила", а затем щелкните "Наборы правил".

    Снимок экрана: боковая панель страницы "Параметры" для репозитория. Вложенное меню "Правила" развернуто, а параметр "Наборы правил" описан оранжевым цветом.

  4. Чтобы просмотреть журнал изменений в наборе правил, выберите справа от имени набора правил, а затем выберите History.

    Снимок экрана: страница для наборов правил репозитория. Под кнопкой, помеченной тремя точками, параметр с меткой "Журнал" описывается оранжевым цветом.

  5. Справа от конкретной итерации выберите , а затем нажмите кнопку "Сравнить изменения, восстановить или скачать".

    Снимок экрана: страница журнала наборов правил репозитория. Раскрывающееся меню с тремя точками развернуто и выделено оранжевым контуром.

Импорт набора правил

Существующий набор правил можно импортировать с помощью JSON-файла. Это может быть полезно, если вы хотите применить один и тот же набор правил к нескольким репозиториям или организациям.

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

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

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

  3. В левой боковой панели в разделе "Код и автоматизация" щелкните "Правила", а затем щелкните "Наборы правил".

    Снимок экрана: боковая панель страницы "Параметры" для репозитория. Вложенное меню "Правила" развернуто, а параметр "Наборы правил" описан оранжевым цветом.

  4. Выберите раскрывающийся список "Создать правила", а затем нажмите кнопку "Импорт набора правил".

    Снимок экрана: страница для наборов правил репозитория. Раскрывающееся меню "Создать набор правил" развернуто, а параметр "Импорт набора правил" описан оранжевым цветом.

  5. Откройте экспортируемый JSON-файл.

  6. Просмотрите импортированный набор правил и нажмите кнопку "Создать".

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

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

  • Действия, которые были проверены на наличие одного или нескольких наборов правил и переданы.
  • Действия, которые были проверены на наличие одного или нескольких наборов правил и завершились ошибкой.
  • Действия, в которых кто-то обошел один или несколько наборов правил.

Если набор правил выполняется в режиме "Оценка", можно увидеть действия, которые были бы переданы или завершились ошибкой, если набор правил был активным.

Кроме того, эти инсайты доступны через REST API наборов правил.

Снимок экрана: страница "Аналитика правил" Три действия помечены как "Pass", "Обход" и "Сбой". Не удалось выполнить действие с меткой "оценка".

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

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

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

  3. В левой боковой панели в разделе "Код и автоматизация" щелкните "Правила **", а затем нажмите **кнопку "Аналитика".

    Снимок экрана: боковая панель страницы "Параметры" для репозитория. Вложенное меню "Правила" развернуто, а параметр "Аналитика" выделен оранжевым цветом.

  4. На странице "Аналитика правил" используйте раскрывающееся меню в верхней части страницы, чтобы отфильтровать действия по набору правил, ветви, субъекту и периоду времени.

  5. Чтобы узнать, какие определенные правила завершились ошибкой или требуется обход, щелкните , а затем разверните имя набора правил.

    Снимок экрана: страница "Аналитика правил" Справа от события с меткой "не разрешено", значок трех горизонтальных точек описывается оранжевым цветом.

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

Dashboard Rules Insights

Примечание.

Панель управления правилами Insights уже включена public preview и может измениться. Он доступен для GitHub Team и GitHub Enterprise Cloud планов.

Панель анализа правил предоставляет вам визуальное общее резюме деятельности по оценке правил для вашего репозитория, включая:

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

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

Чтобы просмотреть панель управления:

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

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

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

  3. В левой боковой панели в разделе "Код и автоматизация" щелкните "Правила **", а затем нажмите **кнопку "Аналитика".

  4. В верхней части страницы «Инсайты правил» просмотрите диаграммы панели для обзора активности по оценке правил.

Управление запросами для обхода правил push-отправки

Вы можете просматривать и управлять всеми запросами для обхода привилегий на странице "Обход запросов", расположенной в параметрах правил репозитория.

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

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

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

  3. Щелкните " Обходить запросы".

Запросы можно фильтровать по утверждающий (член списка обхода), запрашивающий (участник, выполняющий запрос), временный интервал и состояние. Следующие состояния назначаются запросу:

СостояниеDescription
CancelledЗапрос был отменен участником.
CompletedЗапрос был утвержден, и фиксации были отправлены в репозиторий.
DeniedЗапрос был рассмотрен и отклонен.
ExpiredСрок действия запроса истек. Запросы действительны в течение 7 дней.
OpenЗапрос еще не был проверен или утвержден, но фиксации не были отправлены в репозиторий.

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

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