Actions8
- Issue Actions
- Measure Actions
- Project Actions
- Quality Gate Actions
Quality Gate → Get Project Status
AI-generatedOverview
This node interacts with the SonarQube API to retrieve the quality gate status of a specific project. It is useful for monitoring the quality gate results of projects in SonarQube or SonarCloud, helping teams ensure their code meets quality standards before deployment. For example, it can be used in CI/CD pipelines to automatically check if a project passes its quality gate based on the latest analysis.
Use Case Examples
- Retrieve the quality gate status for a project identified by its project key to determine if it meets the defined quality criteria.
- Use the node to fetch quality gate status for a specific branch or pull request to monitor code quality in different development contexts.
Properties
| Name | Meaning |
|---|---|
| Project Key | The unique key identifying the project in SonarQube whose quality gate status is to be retrieved. |
| Additional Fields | Optional parameters to specify branch name or pull request ID to get the quality gate status for a specific branch or pull request. |
Output
JSON
projectStatus- The quality gate status information of the specified project, including details such as status, conditions, and metrics.
Dependencies
- Requires an API key credential for SonarQube or SonarCloud to authenticate requests.
Troubleshooting
- Common issues include invalid or missing project keys, which result in errors from the SonarQube API. Ensure the project key is correct and exists in the SonarQube instance.
- Authentication errors may occur if the API key credential is incorrect or missing. Verify the API key and server URL in the node credentials.
- If specifying branch or pull request in additional fields, ensure these values exist for the project in SonarQube to avoid empty or error responses.
Links
- SonarQube Web API Documentation - Official documentation for SonarQube Web API endpoints, including quality gate status retrieval.