How do show my tests passing/failing in Github?

Question

I have a project on github that has extensive unit tests (using mocha for node.js).

I'd like to show off by showing those tests passing/failing on each page. I notice other projects on Github are doing this.

I've been unable to find any documentation on how to make the test status display.

• How can I make Github show unit test output?
• Does Github run the tests or do you need to hook up with an external webapp?
• Is there a free webservice to do this (my app is Open Source)?

Answer 1

Note that since April 26th 2013, you can see the build status on your GitHub repo branch page:

The Commit Status API allows you to use that elsewhere: see " Repo Statuses API".

Starting April 30th, 2013, the API endpoint for commit statuses has been extended to allow branch and tag names, as well as commit SHAs.

Answer 2

Yes I'm quite sure you mean something like Jenkins or https://travis-ci.org/ They work on your github account! On every commit the tests are executed.

Answer 3

CircleCI the status badges are also simply images that you can drop into your README.md file with the markdown. For example:

![Build Status](https://circleci.com/gh/<your github name>/<repo name>.png?circle-token=:circle-token)

or

![Build Status](https://circleci.com/gh/<your github name>/<repo name>.svg?style=shield&circle-token=:circle-token)

Answer 4

Take a look at Travis CI. You can use it with GitHub.

They have docs on using NodeJS

Those badges you see are called "status images" and Travis provides MarkDown that you can insert into your project's README.md file.