Branching and Quality Protection

1. First, create a project. On the top right, click and choose Project:

   

   Give your project a name and click Create.

2. Next, add a new repository. Navigate to your new project:

   

   And click New repository at the bottom of the page.

3. In the New repository window:

   1. Choose Import a repository.

   2. Specify your GitHub repository URL and its name in SpaceCode.

   3. Turn on Mirror changes from external repository.

   4. Under Authentication, choose Token and click Get a new token to get an access token from GitHub. Once you get it, paste the token to the text field.

   

4. Click Create.

5. Important! Ensure all developers have switched to the new Git remote (the mirror in SpaceCode). Otherwise, all repository restrictions we apply in the further steps won't make any sense.

1. Navigate to your repository and open its Settings.

   

2. On the left sidebar menu, choose Protected Branches, then click New rule.

   

3. In the New Branch Protection Rule window:

   1. Add +:main to Branch name patterns. This is the pattern that allows SpaceCode to determine to which branches it must apply the rule.

   2. Check that Push and Force push under the Regulated actions are set to Nobody.

   

4. Click Save.

To add a code review quality gate

1. Navigate to the repository and open its Settings.

2. On the left sidebar menu, choose Protected Branches, then edit the previously created rule.

   

3. Under Quality Gates for Merge Requests, turn the switch On.

4. In Requirements, open Approvals and specify the required reviewers in the From field. This could be a particular user or a user group. In the require ... approval field, specify how many approvals are enough. For example:

   • From Project Member require 2 approval: a merge request must be approved by at least 2 project members (any members).

   • From Project Admin, John Doe require 1 approval: a merge request must be approved either by John or by any user with the Project Admin role.

   

To add code owners

1. In your project repository, create a CODEOWNERS file. The file must be located either in the project root or in the .space directory.

   Important! The CODEOWNERS file must be on the target branch of the merge request. So, if you protect the main branch, the CODEOWNERS file must be located in the main branch as well.

   In the CODEOWNERS file, assign specific parts of the code base to specific users or user groups. For example:

   # John handles Gradle files *.gradle John.Doe # Sarah handles the source code src Sarah.Connor # CODEOWNERS file is for Project Admins CODEOWNERS "Project Admin"

   For more information about the file syntax, refer to Code Owners.

2. In the repository settings, open Protected Branches, then edit the previously created rule.

3. If Quality Gates for Merge Requests are not yet enabled, turn them On.

4. In Requirements, open Approvals and select the Require approval from code owners checkbox.

   

1. Navigate to the repository, and open its Settings.

2. On the left sidebar menu, choose Protected Branches, then edit the previously created rule.

3. If Quality Gates for Merge Requests are not yet enabled, turn them On.

4. In Requirements, open External checks and select the TeamCity build.

   

1. Let's start by adding a new branch specification to the project's VCS root in TeamCity. We must do this because TeamCity monitors only the refs/heads/* branches by default, but SpaceCode creates temporary merge commits in refs/merge/<merge-request-name>/safe-merge.

   1. In TeamCity, open project settings, then VCS Roots.

   2. Edit the VCS root, namely, in Branch specification, add the line

      +:(refs/merge/*)

   

2. Now, we should create a JSON file that will configure safe merge settings. The exact file location doesn't matter. The main requirement is that you must create the file in the target repository. In our example, it's main.

   Create the file and edit its content. In our case, we need a simple configuration that will specify the TeamCity server settings and the build configuration that must be run during safe merge:

   // If you want to use this example in a real JSON file, delete all comments first! { // Safe Merge version number. Should be "1.0" "version": "1.0", // What to do it build fails. // This setting is helpful for builds with flaky tests. "retry-policy": { // How many build attempts are allowed "num-retries": 3, // Use the same temporary merge commit on a retry // or create a new one "reuse-merge": true }, "builds": [ { "teamcity": { // Build configuration ID // You can get it in build config settings "configuration": "AcmeProject_BuildAndRunTests", // Name of your TeamCity connection // Only required if you have one then one connection set up "connection": "MyTeamCityIntegration" } } ] }

   For details on configuration syntax, refer to the safe merge documentation.

3. Open the repository settings.

4. On the repository settings page, go to Protected Branches, then edit the previously created rule.

5. Turn Safe Merge On and click Select under Configuration file.

   

6. Select the file and click Save.