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

Fix ci-build status badge and link status badge to actions #99

Merged
merged 3 commits into from
Sep 21, 2024

Conversation

drichardson
Copy link
Contributor

@drichardson drichardson commented Sep 16, 2024

Background

Screenshot 2024-09-16 at 11 25 04

The ci-build status badge on README.md is showing no status, even though the action recently ran successfully.

The status badge was added 4 years ago, so I'm guessing GitHub made a breaking change since then, though I found no documentation to confirm this. I suspect the problem is some GitHub edge case related to the name of the yaml file being ci_build.yml but the name of the action being ci-build.

Changes

  1. Updated the badge URL to the current format publised on Add a status badge > Using the branch parameter.
  2. Change badge to link to ci-build action runs on master branch. It previously linked to an SVG of the badge.

Testing

status badge

Before change:

Screenshot 2024-09-16 at 11 30 09

After change:

Screenshot 2024-09-16 at 11 31 09

clicking on badge

Before change, clicking on badge takes you to https://github.com/davidtvs/pytorch-lr-finder/workflows/ci-build/badge.svg?branch=master

After change, clicking on badge takes you to: https://github.com/davidtvs/pytorch-lr-finder/actions/workflows/ci_build.yml?query=branch%3Amaster

Copy link
Owner

@davidtvs davidtvs left a comment

Choose a reason for hiding this comment

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

Thank you for the fix!

@davidtvs davidtvs merged commit 0b5109b into davidtvs:master Sep 21, 2024
2 checks passed
@drichardson drichardson deleted the doug/fix-ci-build-badge branch September 21, 2024 16:02
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.

2 participants