Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README CI badge: explicitly mention branch #332

Closed
elouanKeryell-Even opened this issue Jul 26, 2018 · 2 comments
Closed

README CI badge: explicitly mention branch #332

elouanKeryell-Even opened this issue Jul 26, 2018 · 2 comments
Labels
documentation It's obvious type:enhancement Feature that impacts end-user

Comments

@elouanKeryell-Even
Copy link
Contributor

elouanKeryell-Even commented Jul 26, 2018

README shows build: passing.

It refers to CI build of branch develop, but it doesn't explicitely says so, hence it can mislead user. For example, on a branch where CI does not pass, README will still show build: passing.

The idea is to be more explicit by replacing keyword build in the badge, by the name of the branch whose status is referred to: develop: passing.

We have been using img.shields.io for that purpose (see this commit), but it is under nearly permanent denial of service since its infrastructure is undersized, letting us no choice but to revert (see this commit).

This comment by paulmelnikow, 2nd contributor on badges/shields, mentions another service, badgen, that apparently does not suffer from denial of service.

We should use it, on this project and on all other projects too.

Badges in this issue are generated using https://badgen.now.sh/.

ping @sebbousquet

@elouanKeryell-Even elouanKeryell-Even added type:enhancement Feature that impacts end-user documentation It's obvious labels Jul 26, 2018
@elouanKeryell-Even
Copy link
Contributor Author

Actually, nothing indicates that https://badgen.now.sh/ never goes under denial of service. However, I think its worth trying it, even if it means reverting if it ends up not working well.

@elouanKeryell-Even
Copy link
Contributor Author

In fact, I noticed https://badgen.now.sh doesn't manage changing text of the travis-ci badge, hence it doesn't answer our need.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation It's obvious type:enhancement Feature that impacts end-user
Projects
None yet
Development

No branches or pull requests

1 participant