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

Hook up GitHub Actions results to badge in README #1146

Open
dondi opened this issue Nov 13, 2024 · 2 comments
Open

Hook up GitHub Actions results to badge in README #1146

dondi opened this issue Nov 13, 2024 · 2 comments
Assignees

Comments

@dondi
Copy link
Owner

dondi commented Nov 13, 2024

When GitHub Actions run, it would be good to see the updated badge(s) for them live

@akaiap
Copy link
Collaborator

akaiap commented Nov 20, 2024

  1. I will add the badge using Shields.io
  • Generate the badge URL using Shields.io. The URL format is:
    https://img.shields.io/github/actions/workflow/status/<OWNER>/<REPO>/<WORKFLOW_FILE>?branch=<BRANCH>
  1. I will add badge to the GRNsight's README file
    - ![GitHub Actions Badge](https://img.shields.io/github/actions/workflow/status/<OWNER>/<REPO>/<WORKFLOW_FILE>?branch=<BRANCH>) 4. Commit and push the changes to make badge live and visible
  2. Test Test Test

I will do the same for #1148

@akaiap
Copy link
Collaborator

akaiap commented Nov 29, 2024

Before executing these steps, I tried to find a simpler way within GitHub actions to create a badge and there was!

  1. Within GitHub actions in the workflow, there is an option to create a URL for the status badge.
  2. I copied the markdown and added it to the README repository.
    Success! The badge is now shown in the README!
Screenshot 2024-11-29 at 12 19 55 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants