Getting started with Quality Gate

Learn to start using Quality Gate.

Quality Gate helps users to set quality standards, and automate checks for builds, PR merges, and deployments. This guide can help you set up Quality Gate and understand its key concepts.

Definitions

• Rules: Criteria which are evaluated after a build runs and return a boolean of True or False.
• Quality Profile: A group of configured rules which are evaluated. A single rule failing within a Quality Profile results in the entire Quality Profile failing.
• Quality Gate: The evaluated result of one or more Quality Profiles associated with a build. For every build, there is only a single Quality Gate result.

How to set up Quality Gate

1) Enable the Quality Gate in your project’s settings if it isn’t already. This will ensure the Quality Gate analysis runs at the end of your builds.

If you would like your Quality Gate status to override your build status, check the toggle. (e.g. For a build originally marked “Failed” but the Quality Gate “Passed” - if the override toggle is enabled, the build’s status will be marked as “Passed”)

2) Create a Quality Profile by clicking the Create button. Alternatively, edit an existing profile. This will open up the Profile configuration. Once you have added the required rules and configured other parameters, save the profile. For a more detailed explanation on the different Rules and Quality Profile settings available, read further.

3) Run a build and view the Quality Gate analysis. Once the build completes, the Quality Gate analysis will automatically run. Check the Quality Gate status and detailed breakdown by profile and rules in the Quality Gate widget on the Build Insights page.

4) Integrate the Quality Gate result into your CI/CD to automate workflows. This can currently be done via an API. You can also use a shell script we have created that will help you automatically interpret the Quality Gate result and pass or fail your CI/CD job. Read further here.