Managing custom quality gates

Two built-in quality gates are provided but you can create your own quality gates, called custom quality gates. To manage custom quality gates, you need the Administer Quality Gates permission. With this permission, you can also associate projects to quality gates and allow another user to administer a given custom quality gate. 

For more information on quality gates, see Introduction to quality gates.

To associate a custom quality gate with projects, see Associating projects with a quality gate.

Creating a custom quality gate

You can create a custom quality gate from scratch or by duplication. When you create a custom quality gate from scratch, the conditions of the built-in quality gate Sonar way are automatically copied to the new record to make your custom quality gate ready for Clean as You Code.

Managing a custom quality gate's conditions

You can add or remove conditions. You can update the value of an existing condition. Remember that you define failing conditions: if one of the conditions is met, the quality gate fails. For more information about conditions, see Quality gate definition based on conditions in Introduction to quality gates.

To update a condition:

1. Select the pen icon in the far right of the condition row. If there is no pen icon, select first the Unlock editing button, below the Conditions section.
   The Update Condition dialog opens.
2. Enter the new condition's value and select Update Condition.

To add a new condition:

1.  Below the Conditions section, select the Unlock editing button.
2. Select Add Condition. The Add Condition dialog opens.
3. In Where? select to which code, new or overall, the condition applies. New code is defined through the New Code Definition.
4. In Quality Gate fails when, select the metric to which the condition applies. For information about the metrics, see Understanding measures and metrics.
5. In Value, enter the condition's value.

To remove a condition:

1. Select the dustbin icon in the far right of the condition row. If there is no dustbin icon, select first the Unlock editing button, below the Conditions section.
   The Delete Condition dialog opens.
2. Select Delete.

Upgrading a quality gate for CaYC

We recommend configuring all your quality gates to make them Clean as You Code (CaYC) ready. For more information, see Quality gate configured for Clean as You Code in Introduction to quality gates. 

If your quality gate is not configured for CaYC, you can easily upgrade it as follows:

1. In the top navigation bar, select Quality Gates.
2. In the left panel, select the custom quality gate you want to upgrade.
3. In This quality gate does not comply with Clean as You Code, select Review and Update Quality Gate. The Update to comply with Clean as You Code dialog opens.
4. Review the proposed update and select Update Quality Gate to execute the update.

Renaming a custom quality gate

1. In the top navigation bar, select Quality Gates.
2. In the left panel, select the custom quality gate you want to rename.
3. In the top right corner of your quality gate, select the Actions button and then Rename. The Rename Quality Gate dialog opens.
4. Enter the new name and select Rename.

Deleting a custom quality gate

1. In the top navigation bar, select Quality Gates.
2. In the left panel, select the custom quality gate you want to delete.
3. In the top right corner of your quality gate, select the Actions button and then Delete. 
4. Confirm the deletion.

Updating quality gates on instance mode change

With the SonarQube  Community Build instance admin permissions, you can change the instance's mode from Standard Experience to MQR Mode and vice versa. After you change the mode, you may have to update some quality gates, as the modes use different metrics and affect software qualities in different ways. See the Changing modes page for details.

You do not have to update Sonar way quality gates as they are updated automatically for each mode.

When an update to a custom quality gate is available, you will see an update icon on the list of your custom quality gates. 

To update your quality gate:

• Select a quality gate that displays the update icon from the list of quality gates.
• Click on each condition that displays the update icon and go through the update process. You cannot edit conditions until they are updated.

The conditions' metrics will be calculated differently even if the conditions' names persist between the modes. Operator and value will remain unchanged.

Allowing a user or group to manage a custom quality gate

You can grant a user or group the Administer Quality Gates permission for an existing custom quality gate. You can remove the permission any time.

Proceed as follows:

1. In the top navigation bar, select Quality Gates.
2. In the left panel, select the custom quality gate.
3. In the Permissions section, at the bottom of the quality gate page, select Grant permissions to a user or group. The Grant permissions dialog opens.
4. Select the user or group you want to grant.
5. Select Add. The user or group is added to the Permissions section.
   To remove it, select the dustbin icon.