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 badges #169

Merged
merged 4 commits into from
Feb 1, 2022
Merged

README badges #169

merged 4 commits into from
Feb 1, 2022

Conversation

egpbos
Copy link
Member

@egpbos egpbos commented Jan 27, 2022

Fixes #128, i.e. it adds a green howfairis badge now that #113 has been merged, and adds a GH Action to check this from now on.

This PR also reorders badges a in three ways:

  1. Uninteresting badges are removed
  2. Some top README badges are moved down to relevant sections, so that the ones at the top stand out more.
  3. badges.md is removed, further cleaning up the repo (again following Cleanup files #120).

@egpbos egpbos requested review from elboyran and cwmeijer January 27, 2022 16:30
@egpbos
Copy link
Member Author

egpbos commented Jan 27, 2022

The GH Action fails because it checks the current readme, not the one after merging... a bit weird actually. I just used the suggested template at https://github.com/fair-software/howfairis-github-action, but maybe we should customize it to run on the actual checked out repository instead of on the current only main-branch version.

Copy link
Member

@cwmeijer cwmeijer left a comment

Choose a reason for hiding this comment

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

The branch the how-fair-is action is checking (main) can certainly lead to confusing situations later on. It would be worth our time to see if we can fix this to use the current branch instead. It is already complicated enough to understand what the actions are actually checking as it is.

Great that you were able to get the 5th check for how-fair-is! Great cleanup of repo and readme!

env:
PYCHARM_HOSTED: "Trick colorama into displaying colored output"
with:
MY_REPO_URL: "https://github.com/${{ github.repository }}"
Copy link
Member

Choose a reason for hiding this comment

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

Doesn't seem super easy to make it work with our current branch instead of main. bummer.

Copy link
Member Author

Choose a reason for hiding this comment

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

It was doable! However, for some reason howfairis doesn't properly detect the badge on the README.md... Shall we merge and see if that fixes it? If not, we should probably do a bug report with them.

egpbos added a commit that referenced this pull request Jan 31, 2022
Note: the badge that's mentioned ("see badge") is added to the top of the section in PR #169.
@egpbos egpbos merged commit 7b44550 into main Feb 1, 2022
@loostrum loostrum deleted the 128_howfairis_badge branch February 11, 2022 09:19
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.

Add howfairis badge and Action
2 participants