添加工作流状态徽章

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

本文内容

Note

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

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

工作流状态徽章的屏幕截图。 从右到左显示：GitHub 徽标、工作流名称（“GitHub Actions 演示”）和状态（“正在传递”）。

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

使用 UI

可以使用工作流文件名、分支参数和事件参数直接在 UI 上创建工作流状态锁屏提醒。

  1. 在 GitHub 上，导航到存储库的主页面。

  2. 在存储库名称下，单击 “操作”。

    “github/docs”存储库的选项卡的屏幕截图。 “操作”选项卡以橙色边框突出显示。

  3. 在左侧边栏中，单击您想要查看的工作流程。

    “操作”选项卡的左侧边栏的屏幕截图。工作流“CodeQL”以深橙色标出。

  4. 在页面右侧的“Filter workflow runs”字段旁边，单击 以显示下拉菜单，然后单击“Create status badge”****。

  5. （可选）如果要显示与默认分支不同的某个分支的状态锁屏提醒，请选择该分支。

  6. （可选）选择将触发工作流的事件。

  7. 单击“ Copy status badge Markdown”****。

  8. 将 Markdown 复制到 README.md 文件中。

使用工作流程文件名称

可以使用工作流文件的名称生成工作流状态徽章的 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)