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.md: fix CI badge #1239

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

README.md: fix CI badge #1239

wants to merge 2 commits into from

Conversation

knocte
Copy link
Contributor

@knocte knocte commented Nov 14, 2024

Somehow, it was using the old format (with the workflow name
and without the /actions/ subfolder in the path):

https://github.com/MetacoSA/NBitcoin/actions/workflows/master.yml/badge.svg?branch=master&event=push

And somehow, instead of generating a broken link, it was just
showing always a red CI.

But using the new badge format fixes this, which is explained
here:

https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/adding-a-workflow-status-badge

Which says that it should rather have the workflow filename
(not workflow name), and include the /actions/ subfolder in
the path:

https://github.com/MetacoSA/NBitcoin/actions/workflows/master.yml/badge.svg?branch=master&event=push

Somehow, it was using the old format (with the workflow name
and without the /actions/ subfolder in the path):

https://github.com/MetacoSA/NBitcoin/actions/workflows/master.yml/badge.svg?branch=master&event=push

And somehow, instead of generating a broken link, it was just
showing always a red CI.

But using the new badge format fixes this, which is explained
here:

https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/adding-a-workflow-status-badge

Which says that it should rather have the workflow *filename*
(not workflow name), and include the /actions/ subfolder in
the path:

https://github.com/MetacoSA/NBitcoin/actions/workflows/master.yml/badge.svg?branch=master&event=push
It's better that the workflow file name has the same name
as the workflow name; and let's rather not use 'master'
because that is the main branch name, and this workflow
runs for any branch, not just this branch.
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.

1 participant