This documentation relates to QuickBuild 8.0.x
Select here if you are using a different version

Badge for build status

Version 1 by Steve Luo
on Feb 27, 2018 02:21.

 
compared with
Current by Steve Luo
on Feb 27, 2018 02:21.

 
Key
These lines were removed. This word was removed.
These lines were added. This word was added.

View page history


There are 1 changes. View first change.

 QuickBuild can generate a badge image for build status, report stats, so you can add the badge image to markdown, or anywhere you want.
  
 h2. URL syntax
  
 The badge url can be located at:
 {code}
 http://your-server/rest/badge/build/{buildIdOrName}/{type}.svg
 {code}
  
 h3. buildIdOrName
 _buildIdOrName_ is a build id or a name, the name is in the following format:
 {code}
 {configurationId}.{buildName}
 {code}
  
 buildName can be one of the following value:
 * latest
 * latest_successful
 * latest_failed
 * latest_timeout
 * latest_cancelled
  
  h3 type
  h3. type
 _type_ can be one of the following value:
  
 * *status* build status
 * *boost* Boost test report
 * *bullseye* Bullseye report
 * *busted* Busted report
 * *checkstyle* CheckStyle report
 * *clover* Clover report
 * *cobertura* Cobertura report
 * *codenarc* Codenarc report
 * *coverity* Coverity report
 * *cpd* CPD report
 * *cppcheck* CPPCheck report
 * *emma* EMMA report
 * *findbugs* FindBugs report
 * *fxcop* Fxcop report
 * *Jacoco* Jacoco report
 * *junit* JUnit report
 * *mbunit* MBUnit report
 * *mstest* MSTest report
 * *ncover* NCover report
 * *pmd* PMD report
 * *tap* TAP report
 * *testng* TestNG report
 * *valgrind* Valgrind report
  
 h2. Example
  
 Below is an example that shows how to add a badge to GitHub README in markdown:
  
 {code}
 [![Build status](http://demo.pmease.com/rest/badge/build/25.latest/status.svg)](http://demo.pmease.com)
 {code}
  
 See it in action in below url:
  
 https://github.com/steveluo/qb