Maintaining your custom quality profiles

You should regularly maintain your custom quality profiles that do not inherit from a built-in profile. The built-in quality profiles are regularly updated to reflect the addition of new rules and the deprecation of existing ones. As a user with Administer Quality Profile permission, you will be notified by email each time a built-in profile is updated. Updates can be introduced through a SonarQube or third-party analyzer upgrade.  

To edit a custom quality profile, you need the Administer Quality Profiles permission or be authorized to manage this particular profile. To delete a custom quality profile, you need the Administer Quality Profiles permission.

Ensuring your quality profile has all relevant new rules

To ensure that your custom quality profile has all relevant new rules, you can check for the recently added rules and for the stagnant profiles. Stagnant profiles are custom profiles that have not been updated for more than one year.

In the Quality Profiles page

To check for recently added rules and stagnant profiles:

1. Go to Quality profiles. The right-hand side of the Quality Profiles page shows the stagnant profiles and recently implemented rules.
2. To inspect a new rule, select it in the Recently Added Rules section.
3. To edit a stagnant profile, select it in the Stagnant Profiles section. The quality profile page opens. To add the new rules to your profile, you can now:
   • Either select <x> inactive rules in the Inheritance section and then activate the new rules from the list of inactive rules.
   • Or compare the stagnant profile with the built-in profile.

In the Rules page

To check for recently added rules:

1. Go to the Rules page.
2. In Filters, set the Available Since criterion.

Managing the deprecated rules in quality profiles

A deprecated rule is a rule that SonarQube will not be supported any more in the near future. A rule may be deprecated if it has become obsolete or if it has been replaced by one or several new rules. When a rule becomes deprecated, it will be deactivated in the corresponding language’s built-in profile and in the profile inheriting from it.

If your custom profile does not inherit from the built-in profile, you should regularly check your quality profiles for deprecated rules as follows:

1. Go to the Quality Profiles page. On the right-hand side of the page, the  Deprecated Rules section lists the quality profiles containing deprecated rules.

2. To manage one of these profiles, select the <x> rules hyperlink under the profile name. The list of deprecated rules in the profile is displayed.

3.  To deactivate a rule, select the respective Deactivate button. To deactivate all rules at a time, select Bulk Change > Deacivate in <profile> in the top tool bar.

Deleting a quality profile

To delete a custom quality profile:

1. Go to Quality Profiles and retrieve the custom quality profile you want to delete.
2. In the top right corner of the quality profile page, select the three-dot button and select Delete in the menu. A confirmation dialog opens.
3. Select Delete.

Related pages

• Comparing quality profiles
• Disabling the email notification on built-in quality profile update
• Understanding quality profiles
• Retrieving and viewing quality profiles
• Creating a custom quality profile
• Changing a custom quality profile
• Associating a quality profile with projects
• Changing a language's default quality profile
• Authorizing other users to manage a custom quality profile