Managing quality profiles for AI code
Overview
SonarQube Server's AI Code Assurance features help you set appropriate standards for projects containing AI-generated code. The process begins with labeling projects containing AI code and continues with Applying a quality gate for AI Code Assurance. The final step involves assigning a quality profile recommended for AI Generated code to assign a collection of rules applied during an analysis.
If you need more information about what a quality profile does, please read Understanding quality profiles. There, you’ll learn how quality profiles are assigned by language, what the inheritance tree looks like, and how to profiles are associated with projects.
Quality profiles for AI code
The Sonar way quality profile and its derivatives are excellent choices for AI-generated code. Leveraging the Sonar way provides a solid foundation, and extending it allows for tailored rule sets to further enhance coverage. While the Sonar way profile currently features the recommended for AI-generated code badge , we are actively working to broaden this recognition to include customized profiles in upcoming releases. Using Sonar way is a great starting point for setting up robust analysis for projects with AI code and allows for the creation and assignment of custom profiles that meet specific needs.
Recommendations on custom quality profiles for AI code
The Sonar way quality profile is recommended for projects containing AI-generated code. It and any of its derivatives, which may apply more rules than the parent to an analysis, are recommended for AI code. The Sonar way is recommended because it contains the most optimum rules and thresholds for most projects, and helps detect issues at scale that might be introduced by the injection of AI-generated code.
If you want to add rules or avoid unexpected changes on the BUILT-IN profile, copy the Sonar way and modify it to fit your workflow. Choosing a different quality profile will not affect your AI Code Assurance status.
Assigning a quality profile for AI code
The "Sonar way" profile comes BUILT-IN and ready to use for every programming language. If you haven't changed your default settings, this profile will automatically be applied to all new projects you create.
You aren’t required to use a profile recommended for AI-generated code to get the benefits of AI Code Assurance. However, using one is highly encouraged as it helps keep all your projects consistent and organized.
Assign profiles by project
To assign a quality profile recommended for AI code to multiple languages by project, navigate to the Your project > Project Settings > Quality profiles page. Under each language you have in your project, select a profile that’s a derivative of the Sonar way by selecting the pencil in the Actions column and choosing your already created profile. See the Creating a quality profile page for more information if needed.
Assign profiles by language
To assign an AI Code Assured profile to multiple projects by language, go to the top level Quality Profiles page and pick the language you want to update. You'll likely see the default Sonar way profile, or if it's been copied or extended, you'll also see those versions. Check the Retrieving and viewing quality profiles page to understand how profiles are displayed in the SonarQube UI.
Next, with your desired profile chosen, find the Projects list and select Change Projects. Adjust the With/Without/All filters to see the desired list of your projects. Then, just check or uncheck the boxes to select or deselect projects and select Close to save your changes. If the changes don't show up right away, refresh the page.
Remember, after assigning a new quality profile, you'll need to run a new analysis to see the update on the project's Information page.
For detailed instructions about assigning quality profiles, check out the Associating a quality profile with projects page.
Customizing a quality profile for AI code
Any derivative of the Sonar way can be extended to cover more rules and catch more issues. Please see the Creating a quality profile page for complete details.
Remember that at this time, only the Sonar way carries the recommended for AI-generated code badge ; the ability to assign that badge to custom profiles is on our development roadmap.
Related pages
- Overview of AI capabilities
- Setting your quality standards for AI Code Assurance
- Setting up AI features for instance administration
- Setting up AI Code Autodetection in projects using GitHub and GitHub Copilot
- Enabling AI CodeFix to get AI-generated fix suggestions
Was this page helpful?