github badges and branches

Question

Does anyone know of a good way to display badges for Travis CI, etc. on the main page of a Github repo without keeping them in version control?

I like to have the badges on the front page, but if they're committed in the README then every branch & fork references the badges from master. It'd be better to have no badges on the development branches than incorrect ones.

Seems similar to: http://stackoverflow.com/questions/18673694/referencing-current-branch-in-github-readme-md — Philippe, Dec 27 '15 at 00:39

score 19 · Answer 1 · answered Oct 19 '16 at 00:07

19

We're lazy and just put a table in markdown that shows separate badges for master and develop

No need to worry about merging blips then

answered Oct 19 '16 at 00:07

learnvst

15,455
16
74
121

I like this approach! I suffered with trying to update readmes between branches. – The Sammie Jan 03 '21 at 18:00

score 1 · Answer 2 · answered Oct 18 '16 at 23:58

In your readme link them using markdown to generate the buttons. Travis CI and code climate provide premade buttons to use in your readme. For other services you can make your own in the same format with shields.io (I don't believe they are dynamic but you can update them manually)

score 0 · Answer 3 · answered Dec 27 '15 at 00:37

I like to have the badges on the front page, but if they're committed in the README then every branch & fork references the badges from master.

This is only true if the README for every branch & fork references the same badge. If you want each branch to show it's status simply update the README for the branches.

Assuming when you say I like to have the badges on the front page you mean within the README of the default branch in github: You can do this by simply editing the README in your default branch with a list of status badges. All of this is just source control management and leveraging the fact that github renders markdown: You can't really script anything within github itself. It's conceivable that you could automate this for dynamic branches using git hooks, but I'm unaware of anybody who's done this.

github badges and branches

3 Answers3