Start FreeLogin

Managing custom quality gates

You can create your own, custom quality gates in SonarQube Cloud. To manage custom quality gates, you must have the Administer Quality Gates permission.

Two built-in quality gates are provided in your organization 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 in your organization.

For more information about quality gates, read the Understanding quality gates page.

To associate a custom quality gate with projects, check out the Associating a quality gate with projects page.

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.

From scratch

  1. See Retrieving your organizations to access your organization.

  2. In organization’s navigation bar, select Quality Gates.

  3. In the left panel, select the Create button. The Create Quality Gate dialog opens.

  4. In the dialog, enter the name of the new quality gate and select Create.

  5. You can now update, add or remove the conditions of the new quality gate. See Managing a custom quality gate’s conditions below.

You can create a custom quality gate from scratch in SonarQube Cloud by selecting the Create button.
By duplication

  1. See Retrieving your organizations to access your organization.

  2. In organization’s navigation bar, select Quality Gates.

  3. In the left panel, select the quality gate you want to duplicate.

  4. In the top right corner of the quality gate, select the More Actions button and then Copy. The Copy Quality Gate dialog opens.

  5. In the dialog, enter the name of the new quality gate and select Copy.

  6. You can now update, add or remove the conditions of the new quality gate. See Managing a custom quality gate’s conditions below.

Select the three-dots menu to copy an existing SonarQube Cloud quality gate that you want to customize.

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 the article about Quality gate definition based on conditions.

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. Select Add Condition. The Add Condition dialog opens.

  2. In Where? select to which code, new or overall, the condition applies. New code is defined through the New Code Defintion (NCD). See theQuality standards and new code page for more information.

  3. In Quality Gate fails when, select the metric to which the condition applies. For information about the metrics, see the Understanding measures and metrics page.

  4. In Value, enter the condition’s value.

Quality gate conditions related to severity currently use type severities. For more details, see the list of Issue management solution metrics in the Issues table.

To remove a condition:

  1. Select the dustbin icon in the far right of the condition row. The Delete Condition dialog opens.

  2. Select Delete.

Upgrading a quality gate for CaYC

We recommend configuring all your quality gates to prevent issues in new code. For more information, see the Quality gate and new code article.

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

  1. See Retrieving your organizations to access your organization.

  2. In organization’s navigation bar, select Quality Gates.

  3. In the left panel, select the custom quality gate you want to upgrade.

  4. In You are a few conditions away from Clean as You Code, select Review and Update. The Update Quality Gate dialog opens.

  5. Review the proposed update and select Update Quality Gate to execute the update.

Renaming a custom quality gate

  1. See Retrieving your organizations to access your organization.

  2. In organization’s navigation bar, select Quality Gates.

  3. In the left panel, select the custom quality gate you want to rename.

  4. In the top right corner of your quality gate, select the More Actions button and then Rename. The Rename Quality Gate dialog opens.

  5. Enter the new name and select Rename.

Deleting a custom quality gate

  1. See Retrieving your organizations to access your organization.

  2. In organization’s navigation bar, select Quality Gates.

  3. In the left panel, select the custom quality gate you want to delete.

  4. In the top right corner of your quality gate, select the More Actions button and then Delete.

  5. Confirm the deletion.

Related pages

PreviousViewing a quality gateNextChanging default quality gate

Last updated

Was this helpful?