Защита ветки

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

Создание правила

В профиле репозитория перейдите в Настройки > Ветки > Правила защиты веток и нажмите Добавить правило.

Отобразится форма создания правила защиты ветки.

Пример заполнения формы

1. Шаблон имени для защищенных веток (обязательное поле).

   В примере защищается ветка с названием “master”.

   ⚠️

   В данном поле можно ввести только один шаблон. Если требуется защитить ветку, например, по шаблону “release”, то следует создать новое правило.

2. Шаблоны защищенных файлов (необязательное поле).

   В примере защищаются файлы *.rst.

   ⚠️

   Запрос на слияние будет заблокирован, если в нем изменяются файлы с указанными расширениями.

3. Шаблоны незащищенных файлов (необязательное поле).

   В примере файлы с расширением .txt игнорируют параметры защиты.

4. Ограничение отправки (коммита).

   В примере коммит могут выполнять только author и coAuthor1.

5. Утверждения запросов на слияние.

   В примере необходимое количество одобрений - 2. Для зачета одобрений выбраны coAuthor1 и coAuthor2.

   Дополнительно см. пример в разделе Слияние запроса.

6. Ограничение по слиянию.

   В примере для принятия запросов на слияние выбран author и coAuthor2.

7. Проверка статуса.

   В примере добавлен шаблон из репозитория CICD_examples, ветка CICD_branch_protection_demo.

   Шаблоны для добавления появляются при срабатывании раннера и при добавлении новых заданий в .yaml файл.

8. Нажмите Сохранить.

Шаблон имени для защищённых веток

Для одного правила может быть задана только одна ветка. Правило не сработает, если задано больше одной ветки.

Шаблоны защищённых файлов

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

Шаблоны незащищённых файлов

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

Данная конфигурация защиты позволит сделать коммит в файл readme.txt, несмотря на запрет коммита в ветку:

Данная конфигурация защиты запретит коммит в файл readme.txt, т.к. он подпадает под ограничение на расширение .txt:

Параметры защиты для репозитория организации

Если репозиторий принадлежит организации, то назначать права можно сразу командам разработчиков в параметрах защиты:

1. Право на коммиты.
2. Право на утверждение (approve) запросов.
3. Право получать запросы.

Ограничение отправки

1. Отключить полностью.
2. Разрешить определенному списку. Определяет, кому из соавторов доступна операция “commit”.

Утверждение запросов на слияние

1. Необходимые одобрения. Определяет количество необходимых одобрений, чтобы слияние стало доступным.
2. Определить только определенному списку. Определяет из соавторов, чьи одобрения будут зачтены.
3. Отклонить устаревшие согласования. Задает правило - когда новые коммиты, изменяющие содержимое запроса на слияние, отправляются в ветку, старые согласования будут отклонены.

Ограничения по слиянию

1. Разрешить определенному списку. Задает белый список пользователей, имеющих право принимать запросы на слияние веток (список заполняется только из соавторов).
2. Блокировка слияния по отклоненным отзывам. Слияние будет невозможно, если согласующими запрошены изменения, даже если имеется достаточное количество одобрений.
3. Блокировать слияние при запросах на официальное рассмотрение. Слияние невозможно, если не имеется достаточное количество одобрений официальных представителей.
4. Блокировать слияние, если запрос на слияние устарел. Слияние будет невозможно, если головная ветка находится позади базовой ветви.

Проверка статуса задачи (CI/CD)

Чтобы включить проверку и запретить слияние веток при неудачном выполнении задачи CI/CD:

1. Включите CI/CD в настройках вашего репозитория.

2. Настройте раннер на событие запроса.

3. Создайте или отредактируйте правило защиты веток:

   1. Включите проверку статуса.
   2. Настройте шаблон имени для защищённых веток.
   3. Добавьте дополнительные настройки согласно примеру выше.

Редактирование правила

В профиле репозитория:

1. Откройте вкладку Настройка > Ветки.
2. В блоке Правила защиты веток на нужном правиле нажмите Редактировать.

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

В профиле репозитория:

1. Откройте вкладку Настройка > Ветки.
2. В блоке Правила защиты веток на нужном правиле нажмите Удалить.