Setting up approval rules in a SourceCraft repository

With SourceCraft, you can flexibly set up mandatory approval rules before any code can be added to the target branch of the repository.

For more information, see Approval rules in SourceCraft.

You specify the approval rule configuration for a particular repository and store it in the .sourcecraft/review.yaml file. You can also set the configuration at the SourceCraft organization level.

To set up approval rules in a repository:

1. Clone the repository:

   1. Install Git.

   2. Open the SourceCraft home page.

   3. On the Home tab, under Your craftspace, navigate to Repositories and select your repository.

      Also, you can open any public repository.

   4. In the top-right corner of the repository page, click Clone.

   5. From the HTTPS or SSH field, copy the repository cloning link.

      Depending on the cloning connection protocol, different domains are used:

      Protocol	Domain	Cloning link
      HTTPS	git.sourcecraft.dev	https://git@git.sourcecraft.dev/<organization_slug>/<repository_slug>.git
      SSH	ssh.sourcecraft.dev	ssh://ssh.sourcecraft.dev/<organization_slug>/<repository_slug>.git

   6. In the terminal, run this command:

      git clone <link_for_cloning_repository>
      
      Example of a command for cloning a repository with SourceCraft documentation

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

      Warning

      To clone a private or internal repository, authenticate with a personal access token (PAT) or SSH key.

   7. Go to your cloned repository:

      cd <repository_name>
      

2. Generate an approval rule configuration file named .sourcecraft/review.yaml, e.g.:

   codereview: 
     need_ships: 1 # Required number of approvals from reviewers
     ignore_self_ship: false # Ignore approvals from the pull request author
     ignore_non_reviewers_block: false # Ignore pull request blocking from non-reviewers
     auto_assign: true # Automatically assign reviewers
     rules:
       - patterns:
           - "**" # Repository path pattern
         reviewers:
           usernames: 
             - "<user_name>" # List of reviewers
           assign: 1 # Number of automatically assigned reviewers
           need_ships: 1 # Required number of approvals from reviewers
           ignore_self_ship: false # Ignore approvals from the pull request author
   

   Tip

   For group filtering, we recommend to use the ** pattern because the simple * pattern will not give you a match in expressions with /.

3. Under patterns, specify the repository paths for your approval rules as follows:

   • "**": Apply the rule to the entire repository.
   • "src/**": Apply the rule only to the src directory.
   • "!docs/**": Do not apply the rule to the docs directory.

   You can list multiple patterns one by one, like this:

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

   This way, the rule will apply to any changes in your repository except those in the docs directory.

   Tip

   When using multiple patterns, list the "**" pattern first.

4. Under usernames, list the users the pull request must feature at least one approval from.

5. Add the approval rule configuration file to the git index, commit, and push the changes to the main branch:

   git add .sourcecraft/review.yaml
   git commit -m "Added code review configuration"
   git push -u origin main
   

6. Make sure that the approval rules were applied:

   1. Create a test pull request.

   2. Make sure that in the pull request you created:

      • The Overview tab displays the Code Review verification with In progress status.
      • The Reviewers section shows some of the reviewers from among those specified in the approval rule configuration file.

   3. Wait until your pull request is approved.

   4. To merge with the main branch, click Merge.

      The merging can be done only by users with the Repository developer role or higher.

See also

• Getting started with SourceCraft
• Approval rules in SourceCraft
• Continuous integration and continuous deployment in SourceCraft
• Configuring CI/CD in a SourceCraft repository
• Setting up a branch policy in a SourceCraft repository
• Setting up approval rules and branch policies at the organization level in SourceCraft