Настроить правила ревью кода и политики веток на уровне организации в SourceCraft

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

1. Установите Git.

2. Откройте главную страницу SourceCraft.

3. На вкладке Домой в секции Ваша мастерская перейдите в раздел Репозитории и выберите репозиторий.

   Также вы можете открыть любой публичный репозиторий.

4. На странице репозитория в правом верхнем углу нажмите кнопку Клонировать.

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

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

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

6. В терминале выполните команду:

   git clone <ссылка_для_клонирования_репозитория>
   

   Важно

   При первом подключении по SSH перед подтверждением соединения сверьте отпечаток ключа сервера. Это помогает обнаружить подмену сервера. Если отпечатки не совпадают, отмените подключение и обратитесь в поддержку.

   Пример команды для клонирования репозитория с документацией SourceCraft

   git clone https://git@git.sourcecraft.dev/sourcecraft/documentation.git
   

   Важно

   Чтобы склонировать приватный или внутренний репозиторий, аутентифицируйтесь с помощью персонального токена (PAT) или SSH-ключа.

7. Перейдите в склонированный репозиторий:

   cd <имя_репозитория>
   

Создайте файл конфигурации правил ревью кода .sourcecraft/review.yaml:

nano .sourcecraft/review.yaml

Сформируйте файл по шаблону:

codereview: 
  need_ships: 1 # Требуемое количество одобрений от ревьюеров
  ignore_self_ship: false # Игнорировать одобрения от автора предложения изменений
  ignore_non_reviewers_block: false # Игнорировать блокировку предложения изменений от пользователей, не являющихся ревьюерами
  auto_assign: true # Автоматически назначать ревьюеров
  disable_trust: true # Запретить резолюцию «Доверять» для предложений изменений
  rules:
    - patterns:
        - "**" # Паттерн пути в репозитории
      reviewers:
        usernames: 
          - "<имя_пользователя>" # Список ревьюеров
        assign: 1 # Количество ревьюеров, назначенных автоматически
        need_ships: 1 # Требуемое количество одобрений от ревьюеров
        ignore_self_ship: false # Игнорировать одобрения от автора предложения изменений

Синтаксис настроек на уровне организации идентичен синтаксису настроек на уровне репозитория.

В блоке patterns укажите пути в репозитории, по которым будут срабатывать правила ревью кода, например:

• "**" — применять правило для всего репозитория.
• "src/**" — применять правило только для директории src.
• "!docs/**" — не применять правило для директории docs.

Вы можете последовательно использовать несколько паттернов, например:

- patterns:
  - "**"
  - "!docs/**"

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

Добавьте файл конфигурации в индекс git, сделайте коммит и отправьте изменения в главную ветку по умолчанию:

git add .sourcecraft/review.yaml
git commit -m "Добавлен файл с правилами ревью кода для организации"
git push -u origin <имя_главной_ветки>

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

1. Установите Git.

2. Откройте главную страницу SourceCraft.

3. На вкладке Домой в секции Ваша мастерская перейдите в раздел Репозитории и выберите репозиторий.

   Также вы можете открыть любой публичный репозиторий.

4. На странице репозитория в правом верхнем углу нажмите кнопку Клонировать.

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

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

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

6. В терминале выполните команду:

   git clone <ссылка_для_клонирования_репозитория>
   

   Важно

   При первом подключении по SSH перед подтверждением соединения сверьте отпечаток ключа сервера. Это помогает обнаружить подмену сервера. Если отпечатки не совпадают, отмените подключение и обратитесь в поддержку.

   Пример команды для клонирования репозитория с документацией SourceCraft

   git clone https://git@git.sourcecraft.dev/sourcecraft/documentation.git
   

   Важно

   Чтобы склонировать приватный или внутренний репозиторий, аутентифицируйтесь с помощью персонального токена (PAT) или SSH-ключа.

7. Перейдите в склонированный репозиторий:

   cd <имя_репозитория>
   

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

nano .sourcecraft/branches.yaml

Сформируйте файл по шаблону:

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

Где:

• bypass — настройки обхода политик веток для отдельных пользователей. Необязательный параметр.

  • usernames — список имен пользователей, которым разрешено обходить все политики веток. Необязательный параметр.

• 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, удаление и слияние через предложение изменений).

Синтаксис настроек на уровне организации идентичен синтаксису настроек на уровне репозитория.

Добавьте файл конфигурации в индекс git, сделайте коммит и отправьте изменения:

git add .sourcecraft/branches.yaml
git commit -m "Добавлен файл с политиками веток для организации"
git push -u origin <имя_главной_ветки>