Make the Coveralls badge in the README work #385
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tgrego
approved these changes
May 14, 2019
There was a problem hiding this comment.
Great, you can close https://www.ebi.ac.uk/panda/jira/browse/ENSCORESW-3148
:)
|
Actually the |
added 2 commits
May 14, 2019 12:01
The Coveralls URI need to contain the branch name for the badge to work, moreover URIs for GitHub repositories are (now?) different. The URIs use now both are what Coveralls Web site suggests and have been demonstrated to work in case of ensembl-xref.
The new Coveralls URI points to SVG so let us stick with a single format for all badges.
mkszuba
force-pushed
the
bugfix/readme_badge_uris_master
branch
from
b7ebe40
to
54cc2af
Compare
mira13
approved these changes
May 24, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Update Coveralls URIs in README.md so to get the badge working.
Use case
Our Coveralls badge as it is keeps saying "unknown" because it doesn't specify the branch in the URI, which apparently is necessary in case of Coveralls (and recommended for Travis as well). Moreover, the URI itself might be outdated.
Benefits
Actually get the badge to work.
Possible Drawbacks
Keeping it working for release branches will require updating the README as part of the release procedure.
Testing
Have you added/modified unit tests to test the changes?
No.
If so, do the tests pass/fail?
N/A
Have you run the entire test suite and no regression was detected?
No, this is a change to documentation - and a quantitative one at that.