We are introducing a simplified quality criterion to make sure that your new code is always clean!
Clean as You Code criteria are the quality criteria that will keep your new code clean. As you might know, keeping the new code clean is fundamental to the Clean as You Code methodology.
This criteria is part of the built-in quality gate and can be configured in any of your custom quality gates.
Make sure that your quality gate is passing (green) for every pull request merger and routinely on your branches. This way your new code stays clean. Always.
With our commitment to continuously improve SonarQube and SonarCloud as solutions for clean code, we are enhancing the existing “Clean as You Code” criteria. This new update aims to provide an even more robust framework to ensure that all newly developed and modified code consistently meets the highest quality standards.
Sonar way quality gate represents SonarSource’s recommended quality criteria for your new code.
Sonar way will use a brand new condition starting from SonarQube 10.3 release and soon in SonarCloud.
New code has 0 issues !
With the new Clean Code approach, issue types (bug, vulnerability, and code smell) are deprecated. They are all issues now. You may read more here. With this change, the new code is expected to have zero unresolved issues to pass the quality gate.
This condition replaces conditions on security, reliability, and maintainability in the older version of the Sonar way quality gate.
You can customize coverage and duplication conditions with a custom Clean as You Code compliant quality gate (custom quality gates with any conditions of your choice can still be created).
The Clean as You Code methodology focuses on new code, this new stricter criteria is applied only to your new code based on your project’s New Code Definition. This means the number of issues to be resolved will be limited.
If your quality gate fails, consider the following options to resolve open issues:
- We recommend you fix all open issues in the new code
- If you prefer not to fix an issue you may resolve it with a suitable option.
After upgrading to SonarQube 10.3: If your team cannot yet adopt the new criteria:
You can switch back to the previous version of Sonar way quality gate. Among your your quality gates, you can find Sonar way(legacy) quality gate, which is a backup of the old Sonar way. Assign this quality gate to your projects or set it as default.
- Use Sonar way quality gate or a custom Clean as You Code compliant quality gate on as many projects as possible. This way your team can be on the optimal path to Clean Code.
- Fix your custom quality gates to include Clean as You Code criteria.
- Review your project’s New Code Definition, if you feel that the new code period is too long and results in too many issues in the new code scope.
Please feel free to ask any questions or to share feedback here.