注意:GitHub Enterprise Server 目前不支持 GitHub 托管的运行器。 可以在 GitHub public roadmap 上查看有关未来支持计划的更多信息。
注意:无法从外部访问专用存储库中的工作流徽章,因此无法嵌入它们或者从外部站点链接到它们。
状态徽章显示工作流程目前失败还是通过。 添加状态徽章的常见位置是存储库的 README.md
文件,但也可将其添加到你喜欢的任何网页。 默认情况下,徽章显示默认分支的状态。 如果默认分支上没有工作流运行,它将显示所有分支中最近运行的状态。 也可以在 URL 中使用 branch
和 event
查询参数显示特定分支或事件的工作流运行的状态。
若要向 README.md
文件添加工作流状态徽章,请首先找到要显示的状态徽章的 URL。 然后,可以使用 Markdown 将徽章显示为 README.md
文件中的图像。 有关 Markdown 中图像标记的详细信息,请参阅“基本撰写和格式语法”。
使用工作流程文件名称
可以使用工作流文件的名称生成工作流状态徽章的 URL:
HOSTNAME/OWNER/REPOSITORY/actions/workflows/WORKFLOW-FILE/badge.svg
若要在 README.md
文件中显示工作流状态徽章,请使用 Markdown 标记来嵌入图像。 有关 Markdown 中图像标记的详细信息,请参阅“基本撰写和格式语法”。
例如,将以下 Markdown 添加到 README.md
文件,可为文件路径为 .github/workflows/main.yml
的工作流添加状态徽章。 存储库的 OWNER
是 github
组织,REPOSITORY
名称为 docs
。
![example workflow](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)
使用 branch
参数
若要显示特定分支的工作流运行状态,请将 ?branch=BRANCH-NAME
添加到状态徽章 URL 的末尾。
例如,将以下 Markdown 添加到 README.md
文件,可为名称为 feature-1
的分支显示状态徽章。
![example branch parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?branch=feature-1)
使用 event
参数
若要显示 push
事件触发的工作流运行状态,请将 ?event=push
添加到状态徽章 URL 的末尾。
例如,将以下 Markdown 添加到 README.md
文件,可显示由 push
事件触发的工作流运行状态的徽章,该徽章将显示该分支当前状态的生成状态。
![example event parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?event=push)