注意:GitHub Enterprise Server 目前不支持 GitHub 托管的运行器。 可以在 GitHub public roadmap 上查看有关未来支持计划的更多信息。
Note: Workflow badges in a private repository are not accessible externally, so you won't be able to embed them or link to them from an external site.
状态徽章显示工作流程目前失败还是通过。 添加状态徽章的常见位置是存储库的 README.md
文件,但也可将其添加到你喜欢的任何网页。 默认情况下,徽章显示默认分支的状态。 你也可以在 URL 中使用 branch
和 event
查询参数显示特定分支或事件的工作流运行的状态。
To add a workflow status badge to your README.md
file, first find the URL for the status badge you would like to display. Then you can use Markdown to display the badge as an image in your README.md
file. For more information about image markup in Markdown, see "基本撰写和格式语法."
Using the workflow file name
You can build the URL for a workflow status badge using the name of the workflow file:
HOSTNAME/OWNER/REPOSITORY/actions/workflows/WORKFLOW-FILE/badge.svg
To display the workflow status badge in your README.md
file, use the Markdown markup for embedding images. For more information about image markup in Markdown, see "基本撰写和格式语法."
For example, add the following Markdown to your README.md
file to add a status badge for a workflow with the file path .github/workflows/main.yml
. The OWNER
of the repository is the github
organization and the REPOSITORY
name is docs
.
![example workflow](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)
Using the branch
parameter
To display the status of a workflow run for a specific branch, add ?branch=BRANCH-NAME
to the end of the status badge URL.
For example, add the following Markdown to your README.md
file to display a status badge for a branch with the name feature-1
.
![example branch parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?branch=feature-1)
Using the event
parameter
To display the status of workflow runs triggered by the push
event, add ?event=push
to the end of the status badge URL.
For example, add the following Markdown to your README.md
file to display a badge with the status of workflow runs triggered by the push
event, which will show the status of the build for the current state of that branch.
![example event parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?event=push)