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.

enter image description here

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

score 55 · Answer 1 · edited Apr 05 '18 at 11:09

55

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

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

edited Apr 05 '18 at 11:09

mikemaccana

answered Nov 24 '12 at 22:11

relekang

1

Yep, sign in with github. Docs on using NodeJS are at: http://about.travis-ci.org/docs/user/languages/javascript-with-nodejs/ – mikemaccana Nov 24 '12 at 22:49
1

For more detailed instructions follow this link, https://docs.travis-ci.com/user/status-images/ , select the dropdown "markup" option, and paste the text on your github project's README.md file – rtrujillor Dec 16 '15 at 12:28
Is there any way to use Travis CI if my GitHub project is WinForms? It does not seem to work for me. Perhaps, any other CI tool that's available for Windows-specific open source projects? – Victor Zakharov Mar 21 '16 at 19:14

VonC · Answer 2 · 2013-04-30T13:07:15.903

13

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

build status on GitHub repo branches

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.

edited Apr 30 '13 at 13:07

answered Apr 26 '13 at 23:51

VonC

score 7 · Answer 3 · edited Jun 14 '16 at 14:05

7

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)

edited Jun 14 '16 at 14:05

sebix

answered May 15 '16 at 07:14

mjhm

Your URL for CircleCI is a 404. Do you have an updated link? – shanabus Nov 13 '20 at 14:39

score 1 · Accepted Answer · answered Dec 04 '22 at 21:29

1

GitHub also has workflow status badges for GitHub Actions.

The image is usually embedded into the README.md file using Markdown like this:

![example workflow](https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW>.yml/badge.svg)

answered Dec 04 '22 at 21:29

Florian

1

It's been a few years since I asked this question so Travis (used in the original answer) isn't very popular anymore compared to say GitHub Actions. I'm going to mark this as the accepted answer, though people using Circle, Travis etc. should also look at the other answers. – mikemaccana Dec 05 '22 at 11:07

4 Answers4