# 添加工作流状态徽章

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

> \[!NOTE]
> GitHub Enterprise Server 目前不支持 GitHub 托管的运行器。

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

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

![工作流状态徽章的屏幕截图。 从右到左显示：GitHub 徽标、工作流名称（“GitHub Actions 演示”）和状态（“正在传递”）。](/assets/images/help/repository/actions-workflow-status-badge.png)

若要向 `README.md` 文件添加工作流状态徽章，请首先找到要显示的状态徽章的 URL。 然后，可以使用 Markdown 将徽章显示为 `README.md` 文件中的图像。 有关 Markdown 中图像标记的详细信息，请参阅“[基本写作和格式语法](/zh/enterprise-server@3.20/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images)”。

## 使用该 UI

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

1. 在 GitHub 上，导航到存储库的主页面。1. 在仓库名称下，单击“<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-play" aria-label="play" role="img"><path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a6.5 6.5 0 1 0 13 0 6.5 6.5 0 0 0-13 0Zm4.879-2.773 4.264 2.559a.25.25 0 0 1 0 .428l-4.264 2.559A.25.25 0 0 1 6 10.559V5.442a.25.25 0 0 1 .379-.215Z"></path></svg> Actions”\*\*\*\*。

   ![“github/docs”存储库的选项卡的屏幕截图。 “操作”选项卡以橙色边框突出显示。](/assets/images/help/repository/actions-tab-global-nav-update.png)1. 在左侧边栏中，单击您想要查看的工作流程。

   ![“操作”选项卡的左侧边栏的屏幕截图。工作流“CodeQL”以深橙色标出。](/assets/images/help/actions/superlinter-workflow-sidebar.png)
2. 在页面右侧的“筛选工作流运行”字段旁边，单击 <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-kebab-horizontal" aria-label="Show workflow options" role="img"><path d="M8 9a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3ZM1.5 9a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Zm13 0a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Z"></path></svg> 显示下拉菜单，然后单击“创建状态徽章”\*\*\*\*。
3. （可选）如果要显示某个与默认分支不同的分支的状态徽章，请选择该分支。
4. （可选）选择将触发工作流的事件。
5. 单击 **<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-copy" aria-label="copy" role="img"><path d="M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 0 1 0 1.5h-1.5a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-1.5a.75.75 0 0 1 1.5 0v1.5A1.75 1.75 0 0 1 9.25 16h-7.5A1.75 1.75 0 0 1 0 14.25Z"></path><path d="M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0 1 14.25 11h-7.5A1.75 1.75 0 0 1 5 9.25Zm1.75-.25a.25.25 0 0 0-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 0 0 .25-.25v-7.5a.25.25 0 0 0-.25-.25Z"></path></svg> 复制状态徽章 Markdown**。
6. 将 Markdown 复制到 `README.md` 文件中。

## 使用工作流程文件名

可以使用工作流文件的名称生成工作流状态徽章的 URL：

```text
HOSTNAME/OWNER/REPOSITORY/actions/workflows/WORKFLOW-FILE/badge.svg
```

若要在 `README.md` 文件中显示工作流状态徽章，请使用 Markdown 标记来嵌入图像。 有关 Markdown 中图像标记的详细信息，请参阅“[基本写作和格式语法](/zh/enterprise-server@3.20/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images)”。

例如，将以下 Markdown 添加到 `README.md` 文件，可为文件路径为 `.github/workflows/main.yml` 的工作流添加状态徽章。 存储库的 `OWNER` 是 `github` 组织，`REPOSITORY` 名称为 `docs`。

```markdown
![example workflow](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)
```

## 使用 `branch` 参数

若要显示特定分支的工作流运行状态，请将 `?branch=BRANCH-NAME` 添加到状态徽章 URL 的末尾。

例如，将以下 Markdown 添加到 `README.md` 文件，可为名称为 `feature-1` 的分支显示状态徽章。

```markdown
![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` 事件触发的工作流运行状态的徽章，该徽章将展示该分支当前状态的构建状态。

```markdown
![example event parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?event=push)
```