GRNsight icon indicating copy to clipboard operation
GRNsight copied to clipboard
verified publisher icon dondi

Hook up GitHub Actions results to badge in README

Open dondi opened this issue 1 year ago • 2 comments

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

dondi avatar Nov 13 '24 21:11 dondi

  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 avatar Nov 20 '24 19:11 akaiap

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

akaiap avatar Nov 29 '24 20:11 akaiap

This issue closes out the CI (continuous integration) badge but not yet coverage. That can be a new issue

dondi avatar Aug 27 '25 17:08 dondi