Node.js server for providing build status badges for GitHub branches.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
public/stylesheets
routes
views
.gitignore
LICENSE
Procfile
README.md
app.js
app.json
debug.sh
package.json

README.md

satellite

License Blog Twitter Czechboy0

Node.js server for providing build status badges for GitHub branches.

Example badges: example badge example badge example badge

Used by Buildasaur, XcodeServerSDK and other projects backed by Xcode Server to show a build status badge like the ones coming from hosted CI services. Since Xcode Server is self-hosted, if you use Buildasaur to sync your build results from Xcode Server to GitHub, you can take advantage of Satellite to get a badge of your own.

🔩 usage

Just add a badge like this to your README and satellite will return the right badge - by going to GitHub and checking the GitHub status (you know, those little green tickmarks and Pull Request statuses) - and returning the appropriate badge.

Add this to your README:

[![satellite badge](https://stlt.herokuapp.com/v1/badge/USER/REPO/BRANCH)](https://github.com/USER/REPO/branches)

If you don't specify a branch, master will be used.

API

/v1/badge/:USER/:REPO/:BRANCH?

And since the service is running on https://stlt.herokuapp.com, an example call would be

HTTP GET https://stlt.herokuapp.com/v1/badge/czechboy0/xcodeserversdk/swift-2

which returns an SVG image of the badge.

/v1/xcs_deeplink/:HOSTNAME/:BOT_ID/:INTEGRATION_ID

Returns 301 redirect to xcbot://HOSTNAME/botID/BOT_ID/integrationID/INTEGRATION_ID so that you can link to your Bots from e.g. GitHub, which blocks all non-https URL schemes.

details

The service uses Redis for caching of the status (1 minute) and of the badge image data (1 hour).

installation

There is an instance running at https://stlt.herokuapp.com, but you can also run your own if you want. Clone the repo and run npm install and then start the server locally with ./bin/www. Or, deploy it to your heroku account: Deploy

💝 Contributing

Please create an issue with a description of a problem or a pull request with a fix.

✌️ License

MIT

👽 Author

Honza Dvorsky - http://honzadvorsky.com, @czechboy0