添加工作流状态徽章

您可以在存储库中显示状态徽章，以指示工作流的状态。

本文内容

注意

私有存储库中的工作流徽章无法从外部访问，因此您将无法从外部站点嵌入或链接到它们。

状态徽章显示工作流当前是失败还是成功。添加状态徽章的常见位置是存储库的README.md文件，但您也可以将其添加到任何您喜欢的网页中。默认情况下，徽章显示默认分支的状态。如果您的默认分支上没有工作流运行，它将显示所有分支中最最近一次运行的状态。您可以使用 URL 中的branch和event查询参数显示特定分支或事件的工作流运行状态。

Screenshot of a workflow status badge. The left side contains the octocat logo and "GitHub Actions Demo", the name of the workflow. The right half is green with the text "passing."

要将工作流状态徽章添加到您的README.md文件，首先找到要显示的状态徽章的 URL。然后，您可以使用 Markdown 将徽章作为图像显示在您的README.md文件中。有关 Markdown 中图像标记的更多信息，请参阅“基本编写和格式化语法”。

使用工作流文件名

您可以使用工作流文件名构建工作流状态徽章的 URL

https://github.com/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)