Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jcfr/cbadge
GitHub badges for CMake/CTest/CDash projects.
https://github.com/jcfr/cbadge
Last synced: 1 day ago
JSON representation
GitHub badges for CMake/CTest/CDash projects.
- Host: GitHub
- URL: https://github.com/jcfr/cbadge
- Owner: jcfr
- License: mit
- Created: 2017-03-28T12:10:33.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-17T17:38:49.000Z (almost 8 years ago)
- Last Synced: 2024-11-24T07:42:11.648Z (2 months ago)
- Language: JavaScript
- Size: 80.1 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CBadge
Open source GitHub badges for CMake/CTest/CDash projects. Fork the repository on [GitHub](http://github.com/brennonbrimhall/CBadge).
## Usage
### Badges
CBadge generates four badges for GitHub projects that post dashboards to `http://open.cdash.org/`:
* A configure badge at `http://cbadge-instance/:CDashProjectName/:GitCommitSHA/configure.svg`, like .
* A build badge at `http://cbadge-instance/:CDashProjectName/:GitCommitSHA/configure.svg`, like .
* A test badge at `http://cbadge-instance/:CDashProjectName/:GitCommitSHA/test.svg`, like .
* A coverage badge at `http://cbadge-instance/:CDashProjectName/:GitCommitSHA/coverage.svg`, like .
* Additionally, you can send CBadge the name of a tag or branch to have it automatically redirect you to the correct SHA by using `http://cbadge-instance/:CDashProjectName/:task/:GitHubRepoOwner/:GitHubRepoName/:tag`.
To add badges to your README.md for you GitHub repository, include them with the following syntax:
```
```
#### Pretty Tables
Alternatively, to put them in a nice table format like this:
| Master |
| :---: |
||
||
||
||
Use this markup:
```
| Master |
| :---: |
||
||
||
||
```
You can easily add columns to the status of other branches or tags, which is useful if you have a workflow that involves a stable master branch and a development branch that gets merged into master.
All badges are served with proper headers to ensure that GitHub doesn't cache them.
### As a CI Summary Tool
CBadge can comment on pull requests to inform you of the new builds' status. At the end of a build that submits to the dashboard, simply issue a GET request to `http://cbadge-instance/:CDashProjectName/pullRequest/:GitHubRepoOwner/:GitHubRepoName/:PullRequestNumber/:GitCommitSHA`. For a Travis-CI build, one could add `curl http://cbadges.com/:CDashProjectName/:GitHubRepoOwner/:GitHubRepoName/${TRAVIS_PULL_REQUEST}/${TRAVIS_COMMIT}`.
Example summary:
| Base (9ceac20) | Merged (e3b1423)|
|:---:|:---:|
|[](http://open.cdash.org/index.php?project=Remus)|[](http://open.cdash.org/index.php?project=Remus)
|[](http://open.cdash.org/index.php?project=Remus)|[](http://open.cdash.org/index.php?project=Remus)
|[](http://open.cdash.org/index.php?project=Remus)|[](http://open.cdash.org/index.php?project=Remus)
|[](http://open.cdash.org/index.php?project=Remus)|[](http://open.cdash.org/index.php?project=Remus)
## Installation
```
git clone https://github.com/brennonbrimhall/CBadge.git
cd CBadge
cd cbadge
npm install
```
## Updating
```
git pull
cd CBadge
cd cbadge
npm update
```
## Running
```
sudo npm start
```
To run the CI functionality properly, CBadge needs `CBADGE_URL` and `CBADGE_PASSWORD` to be defined.
```
sudo CBADGE_URL="http://cbadge-instance" CBADGE_PASSWORD="qwerty" npm start
```
To run on a different port than 80, just change the port number specified in `/cbadge/bin/www`. This may let you run CBadge without `sudo`.