SonarQube Quality Gate Check Buildkite Plugin

A Buildkite plugin to check the SonarQube Quality Gate status for a specified branch.

This plugin requires a SonarQube API token and project key.

Other preinstalled requirements:

• curl
• jq

Example

Add the following to your pipeline.yml:

steps:
  - command: "echo 'Running SonarQube Quality Gate Check''"
    plugins:
      - robert-fahey/sonarqube-quality-gate-checker#v1.0:
          api_token: "your-sonarqube-api-token"
          project_key: "your-sonarqube-project-key"

Configuration

api_token (required, string)

Your SonarQube API token to authenticate against the SonarQube Quality Gate endpoint.

project_key (required, string)

The key that identifies your SonarQube project.

Developing

To run the tests:

docker-compose run --rm shellcheck
docker-compose run --rm tests

Contributing

1. Fork the repo
2. Make the changes
3. Run the tests
4. Commit and push your changes
5. Send a pull request