我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

Adding a workflow status badge

You can display a status badge in your repository to indicate the status of your workflows.

GitHub Actions 可用于 GitHub Free、GitHub Pro、组织的 GitHub Free、GitHub Team、GitHub Enterprise Cloud 和 GitHub One。 GitHub Actions 不适用于使用旧版按仓库计划的帐户所拥有的私有仓库。 For more information, see "GitHub's products."

本文内容

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。

A status badge shows whether a workflow is currently failing or passing. 添加状态徽章的常见位置是仓库的 README.md 文件,但也可将其添加到您喜欢的任何网页。 默认情况下,徽章显示默认分支的状态。 您也可以在 URL 中使用 branchevent 查询参数显示特定分支或事件运行的工作流程状态。

示例状态徽章

如果您的工作流程使用 name 关键词,则必须按名称引用工作流程。 如果工作流程名称包含空格,您需要将空格替换为 URL 编码字符串 %20。 有关 name 关键词的更多信息,请参阅“GitHub Actions 的工作流程语法”。

https://github.com/<OWNER>/<REPOSITORY>/workflows/<WORKFLOW_NAME>/badge.svg

或者,如果工作流程没有 name,则必须使用相对于仓库根目录的文件路径引用工作流程文件。

注意:如果工作流程具有 名字,则无法使用文件路径引用工作流程文件。

https://github.com/<OWNER>/<REPOSITORY>/workflows/<WORKFLOW_FILE_PATH>/badge.svg

Using a workflow name

此 Markdown 示例为名为 "Greet Everyone" 的工作流程添加状态徽章。 仓库的 OWNERactions 组织,REPOSITORY 名称为 hello-world

![example workflow name](https://github.com/actions/hello-world/workflows/Greet%20Everyone/badge.svg)

Using a workflow file path

此 Markdown 示例为文件路径为 .github/workflows/main.yml 的工作流程添加状态徽章。 仓库的 OWNERactions 组织,REPOSITORY 名称为 hello-world

![example workflow file path](https://github.com/actions/hello-world/workflows/.github/workflows/main.yml/badge.svg)

Using the branch parameter

此 Markdown 示例为名为 feature-1 的分支添加状态徽章。

![example branch parameter](https://github.com/actions/hello-world/workflows/Greet%20Everyone/badge.svg?branch=feature-1)

Using the event parameter

此 Markdown 示例添加显示通过 pull_request 事件触发运行的工作流程状态的徽章。

![example event parameter](https://github.com/actions/hello-world/workflows/Greet%20Everyone/badge.svg?event=pull_request)

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。