Настроить политику веток в репозитории SourceCraft

Совет

Настройка и просмотр конфигураций репозитория доступны в интерфейсе SourceCraft в разделе Настройки репозитория в секции Конфигурации. Подробнее в инструкции Настроить конфигурации репозитория в виде кода.

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

Подробнее на странице Политики веток в SourceCraft.

Конфигурация политик задается для конкретного репозитория и хранится в файле .sourcecraft/branches.yaml. Для всего репозитория действует конфигурация, которая размещена в основной ветке, например master или main. Вы также можете задать конфигурацию на уровне организации SourceCraft.

Общий вид конфигурации политики в .sourcecraft/branches.yaml:

branch_protection:
  policies:
    - target: <тип_защищаемого_ресурса>
      matches: "<фильтр>"
      message: "<сообщение_пользователю_при_срабатывании>"
      rules:
        - <правило_1>
        - <правило_2>

Где:

target — тип защищаемого ресурса. Обязательный параметр. Возможные значения:
- default_branch — основная ветка, например master или main.
- branch — ветка.
- tag — тег.
matches — фильтр или список фильтров по имени защищаемого ресурса. Обязательный параметр для target: branch и target: tag.
message — сообщение, которое будет показываться пользователю при срабатывании политики. Обязательный параметр.
rules — правило или список правил, которые будут применены к защищаемому ресурсу. Обязательный параметр. Возможные значения:
- prevent_force_push — нельзя переписывать историю коммитов в ветке (выполнять force push).
- prevent_non_pr_changes — нельзя напрямую вносить правки в ветку (выполнять push), только через предложение изменений.
- prevent_all_changes — нельзя выполнять любые действия с веткой или тегом.
  
  Важно
  
  Правило prevent_all_changes устарело. Вместо него используйте связку правил prevent_creation и prevent_update.
- prevent_deletion — нельзя удалять ветку или тег.
- prevent_creation — нельзя создавать ветку или тег.
- prevent_update — нельзя вносить изменения в ветку или тег после создания (запрещены push, force push, удаление и слияние через предложение изменений).

Полная схема находится в подразделе Схема политики веток в формате JSON.

Чтобы настроить политики веток в репозитории:

Склонируйте репозиторий:

Установите Git.
Откройте главную страницу SourceCraft.
На вкладке Домой в секции Ваша мастерская перейдите в раздел Репозитории и выберите репозиторий.

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

Из поля HTTPS или SSH скопируйте ссылку для клонирования репозитория.

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

Протокол	Домен	Ссылка для клонирования
HTTPS	`git.sourcecraft.dev`	`https://git@git.sourcecraft.dev/<слаг_организации>/<слаг_репозитория>.git`
SSH	`ssh.sourcecraft.dev`	`ssh://ssh.sourcecraft.dev/<слаг_организации>/<слаг_репозитория>.git`

В терминале выполните команду:
```
git clone <ссылка_для_клонирования_репозитория>
```
Пример команды для клонирования репозитория с документацией SourceCraft
```
git clone https://git@git.sourcecraft.dev/sourcecraft/documentation.git
```
Важно

Чтобы склонировать приватный или внутренний репозиторий, аутентифицируйтесь с помощью персонального токена (PAT) или SSH-ключа.
Перейдите в склонированный репозиторий:
```
cd <имя_репозитория>
```

Сформируйте файл конфигурации политики веток .sourcecraft/branches.yaml, например:

branch_protection:
  policies:
    ## Запрет переписывания истории коммитов, внесения правок без 
    ## предложения изменений, а также удаления основной ветки
    - target: default_branch
      message: "Direct push into main branch is forbidden, create PR first"
      rules:
        - prevent_force_push
        - prevent_non_pr_changes
        - prevent_deletion

    ## Запрет создания веток с названиями, соответствующими фильтрам
    - target: branch
      matches: ["**", "!OO-**/**", "!hotfix/**", "!chore/**", "!release/**"]
      message: "Please use proper branch naming"
      rules:
        - prevent_creation

    ## Запрет создания тегов с названиями, соответствующими фильтрам
    - target: tag
      matches: "gitcore-**"
      message: "Manual tag creation is forbidden, please use Releaser"
      rules:
        - prevent_creation

Также смотрите пример политики веток в репозитории SourceCraft test-serverless-cube.

Совет

Для групповой фильтрации рекомендуется использовать паттерн **, поскольку простой паттерн * не предусматривает совпадения в выражениях с /.

Подробнее о синтаксисе и правилах применения фильтров по путям в разделе Фильтры и паттерны в SourceCraft.

Добавьте файл конфигурации политики веток в индекс git, сделайте коммит и отправьте изменения в удаленную ветку main:
```
git add .sourcecraft/branches.yaml
git commit -m "Added branch policies configuration"
git push -u origin main
```
Чтобы проверить срабатывание политики веток, внесите изменения в файлы в основной ветке, сделайте коммит и попробуйте отправить изменения в удаленный репозиторий:
```
git add .
git commit -m "Test changes"
git push -u origin main
```
В результате вы получите ошибку с сообщением Direct push into main branch is forbidden, create PR first.

Настроить автоматическое удаление веток после слияния

Вы можете настроить автоматическое удаление ветки-источника предложения изменений после слияния с целевой веткой. Подробнее в разделе Автоматическое удаление веток после слияния.

Чтобы настроить автоматическое удаление веток:

Склонируйте репозиторий:

Установите Git.
Откройте главную страницу SourceCraft.
На вкладке Домой в секции Ваша мастерская перейдите в раздел Репозитории и выберите репозиторий.

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

Из поля HTTPS или SSH скопируйте ссылку для клонирования репозитория.

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

Протокол	Домен	Ссылка для клонирования
HTTPS	`git.sourcecraft.dev`	`https://git@git.sourcecraft.dev/<слаг_организации>/<слаг_репозитория>.git`
SSH	`ssh.sourcecraft.dev`	`ssh://ssh.sourcecraft.dev/<слаг_организации>/<слаг_репозитория>.git`

В терминале выполните команду:
```
git clone <ссылка_для_клонирования_репозитория>
```
Пример команды для клонирования репозитория с документацией SourceCraft
```
git clone https://git@git.sourcecraft.dev/sourcecraft/documentation.git
```
Важно

Чтобы склонировать приватный или внутренний репозиторий, аутентифицируйтесь с помощью персонального токена (PAT) или SSH-ключа.
Перейдите в склонированный репозиторий:
```
cd <имя_репозитория>
```

В файл .sourcecraft/branches.yaml добавьте секцию pull_request.branch_cleanup и в параметре matches укажите фильтры по путям, которые определяют, для каких веток будет включено автоматическое удаление, например:
```
pull_request:
  branch_cleanup:
    matches: ["**", "!hotfix/**", "!chore/**", "!release/**"]
```
В этом примере автоматическое удаление включено для всех веток, кроме веток hotfix/**, chore/** и release/**.

Совет

Для групповой фильтрации рекомендуется использовать паттерн **, поскольку простой паттерн * не предусматривает совпадения в выражениях с /.
Добавьте измененный файл конфигурации в индекс git, сделайте коммит и отправьте изменения в удаленную ветку main:
```
git add .sourcecraft/branches.yaml
git commit -m "Configured automatic branch cleanup"
git push -u origin main
```

Совет

Заданное в файле .sourcecraft/branches.yaml поведение можно переопределить для отдельного предложения изменений с помощью опции Удалять ветку-источник после слияния в блоке Настройки слияния. Подробнее на странице Работа с предложениями изменений в SourceCraft.

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

Важно

Обойти правила политики веток, например чтобы поправить конфигурацию в .sourcecraft/branches.yaml, могут только пользователи с ролью Администратор репозитория.

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

Полезные ссылки

Была ли статья полезна?

Настроить правила ревью кода

Настроить конфигурацию на уровне организации