Skip to content

Add gem version and semver stability badges to README #2003

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

Merged
merged 3 commits into from
Jan 13, 2019
Merged

Add gem version and semver stability badges to README #2003

merged 3 commits into from
Jan 13, 2019

Conversation

greysteil
Copy link
Contributor

First of all, thanks for rspec-rails! I've used it on every Rails project I've ever worked on, and love it.

Would you be up for adding badges that display the current version on rspec-rails, and its semver stability? The former is pretty self-explanatory, the later is a new badge I've made that displays the percentage of rspec-rails users' CI runs that pass when updating rspec-rails between SemVer compatible versions. Data comes from Dependabot (disclosure: I built it).

I've also fixed the Code Climate badge in this PR (the URL must have changed on shields.io).

The badges now look like this:

Build Status Code Climate Gem Version SemVer

@fables-tales
Copy link
Member

@greysteil I'm disinclined to add the "semver stability" badge as I can't independently verify that it actually works, or is in any way meaningful in the ruby programming language. The others we will need to consider.

@greysteil
Copy link
Contributor Author

👍 - I've removed that one. It works pretty well, and picks out the 3.6.1 -> 3.7.0 break, for example, but I appreciate it needs more thought than the other two.

@fables-tales
Copy link
Member

LGTM

@greysteil
Copy link
Contributor Author

Squashed into a single commit. Pretty innocuous change now, and you can confirm it renders here.

Separately, would love to talk you through the SemVer stability score if you're open to it?

@JonRowe
Copy link
Member

JonRowe commented Jun 23, 2018

If we want to have a coverage badge we need to setup coverage, it seems I'm not a member of the organisation, who initially configured RSpec on code climate?

@greysteil
Copy link
Contributor Author

greysteil commented Jun 23, 2018

Just dug into the Code Climate issue. Looks like this commit switched us to shields.io endpoint that is no longer supported, but the original URL still works. I've updated the badge accordingly:

Code Climate

Turns out it was never meant to be coverage (my bad for switching the broken badge to that initially) - it's a "maintainability" badge.

@olleolleolle
Copy link
Contributor

@greysteil Could you rebase your changes? They're neat.

@fables-tales
Copy link
Member

@JonRowe I'm happy to merge this on green if you are.

@JonRowe
Copy link
Member

JonRowe commented Dec 19, 2018

I'm happy if the builds green

@greysteil
Copy link
Contributor Author

greysteil commented Dec 19, 2018

Build is going to be ❌ without #2051.

@fables-tales
Copy link
Member

@greysteil let's rebase this now that the rubygems fix is merged.

Copy link
Member

@benoittgt benoittgt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks! 🎉

@JonRowe JonRowe merged commit c92ce55 into rspec:master Jan 13, 2019
@JonRowe
Copy link
Member

JonRowe commented Jan 13, 2019

❤️

@greysteil greysteil deleted the add-version-badges branch January 13, 2019 21:51
benoittgt pushed a commit to benoittgt/rspec-rails that referenced this pull request May 1, 2019
* Add gem version badge to README

* Fix Code Climate badge
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants