Missing documentation on GitHub Actions badges #27129
-
I see some GitHub repos and many other repos are already using the GitHub actions badges. Example:
is used in https://github.com/actions/toolkit’s readme. However, I can’t find any official docs on that topic. It would be nice if it’s better documented. |
Beta Was this translation helpful? Give feedback.
Replies: 7 comments
-
There’s docs on it now here: https://help.github.com/en/articles/configuring-a-workflow#adding-a-workflow-status-badge-to-your-repository |
Beta Was this translation helpful? Give feedback.
-
What is the best url pointed by the badge? There is
but it seems that |
Beta Was this translation helpful? Give feedback.
-
What about private repos? |
Beta Was this translation helpful? Give feedback.
-
Hi @randy3k, This is the closest I got for my repo:
It links to the actions view filtering by workflow name and branch. This is the code I use in the README to show the badge:
Edit: I just found out that this URL is not public, only registered users can view it. Unfortunately there seems to be nowhere to link from the badge for everyone to see. |
Beta Was this translation helpful? Give feedback.
-
Is there a GitHub Action up easily to add a new event type/status? I included a “deployment” / “deployment_status” Badge and update it via the Action but the Badge doesn’t update |
Beta Was this translation helpful? Give feedback.
-
This link doesn’t point to documentation on badges any more, afaict. Maybe this is the right link now? https://docs.github.com/en/actions/managing-workflow-runs/adding-a-workflow-status-badge |
Beta Was this translation helpful? Give feedback.
-
If I’m not wrong, the documentation doesn’t say anything about the fact that the badge can be created by the web interface: navigate to a workflow, click on the “…” and select “Create status badge”. |
Beta Was this translation helpful? Give feedback.
There’s docs on it now here: https://help.github.com/en/articles/configuring-a-workflow#adding-a-workflow-status-badge-to-your-repository