https://github.com/daggerok/sonar-quality-gates-build-breaker

SonarQube ❤ Build Breaker designed to Fail pipeline builds according to Quality Gates️
https://github.com/daggerok/sonar-quality-gates-build-breaker

github-pages github-tags sonar sonar-maven-plugin sonar-plugin sonar-scanner sonarqube sonarqube-plugin sonarqube-scanner

Last synced: 2 months ago
JSON representation

SonarQube ❤ Build Breaker designed to Fail pipeline builds according to Quality Gates️

• Host: GitHub
• URL: https://github.com/daggerok/sonar-quality-gates-build-breaker
• Owner: daggerok
• License: mit
• Created: 2019-09-20T18:32:40.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-18T04:10:03.000Z (6 months ago)
• Last Synced: 2024-07-19T09:10:15.602Z (6 months ago)
• Topics: github-pages, github-tags, sonar, sonar-maven-plugin, sonar-plugin, sonar-scanner, sonarqube, sonarqube-plugin, sonarqube-scanner
• Language: Java
• Homepage: https://daggerok.github.io/sonar-quality-gates-build-breaker/
• Size: 12.8 MB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SonarQube 💥 Build Breaker [![Build Status](https://travis-ci.org/daggerok/sonar-quality-gates-build-breaker.svg?branch=master)](https://travis-ci.org/daggerok/sonar-quality-gates-build-breaker) [ ![Download](https://api.bintray.com/packages/daggerok/maven/sonar-quality-gates-build-breaker/images/download.svg) ](https://bintray.com/daggerok/maven/sonar-quality-gates-build-breaker/_latestVersion) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.daggerok.sonar/sonar-quality-gates-build-breaker/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.daggerok.sonar/sonar-quality-gates-build-breaker)

SonarQube Build Breaker designed to fail SonarQube analysis during CI pipeline build if quality grates not passed

![SonarQube 💥 Build Breaker](sonar-breaker.png)

_Easy as 1-2-3_

## Maven plugin quick start

1) add `sonar-breaker-maven-plugin` in your project _pom.xml_ file:

   ```xml

   

       

           

               

                   com.github.daggerok.sonar

                   sonar-breaker-maven-plugin

                   1.0.1

                   

               

           

       

   

   ```

 

   see [sonar-breaker-maven-plugin pom.xml] file

2) NOTE: Do not forget setup `sonar-maven-plugin` as well, `sonar-breaker` will be use analysis metadata generated by

   `sonar:sonar` goal execution

3) build project, run sonar analysis and run sonar-breaker analyzer:

   ```bash

   mvn clean install sonar:sonar sonar-breaker:analyze 

   ```

## Sonar Breaker standalone quick start

* build project and examin sonar analysis:

  ```bash

  mvn install sonar:sonar 

  ```

* download latest

  [sonar-breaker](https://repo1.maven.org/maven2/com/github/daggerok/sonar/sonar-breaker/1.0.1/sonar-breaker-1.0.1.jar)

  executable jar file.

  ```bash

  wget -O sb.jar https://repo1.maven.org/maven2/com/github/daggerok/sonar/sonar-breaker/1.0.1/sonar-breaker-1.0.1.jar

  ```

* finally run sonar-breaker analysis:

  ```bash

  java -jar sb.jar target/sonar/report-task.txt

  ```

see [examples] 

enjoy your bugs free code! :+1: 

[examples]: examples/

[sonar-breaker-maven-plugin pom.xml]: examples/sonar-breaker-maven-plugin-demo/pom.xml