徽章
徽章是一种统一的方式来呈现有关您的项目的浓缩信息。它们由一个小图片和图片指向的 URL 组成。徽章的示例:流水线状态、测试覆盖率、最新版本,或联系项目维护者的方式。
项目徽章
徽章可以由维护者或所有者添加到项目中,并且在项目的概览页面上可见。 如果您发现必须为多个项目添加相同的徽章,您可能需要在群组级别添加它们。
向项目添加徽章
为项目添加新徽章:
- 在顶部栏上,选择 主菜单 > 项目 并找到您的项目。
- 在左侧边栏中,选择 设置 > 通用。
- 展开 徽章。
- 在 链接 下,输入徽章应指向的 URL,在 徽章图片网址 下,输入应显示的图片的 URL。
- 选择 添加徽章。
为项目添加徽章后,您可以在表单下方的列表中看到徽章。
编辑或删除项目徽章
要编辑徽章,请选择 编辑 ()。
要删除徽章,请选择 删除 ()。
示例项目徽章:流水线状态
一个常见的项目徽章表示极狐GitLab CI 流水线状态。
将此徽章添加到项目中:
- 在顶部栏上,选择 主菜单 > 项目 并找到您的项目。
- 在左侧边栏中,选择 设置 > 通用。
- 展开 徽章。
- 在 名称 下,输入 流水线状态。
- 在 链接 下,输入以下 URL:
https://jihulab.com/%{project_path}/-/commits/%{default_branch}
- 在 徽章图片网址 下,输入以下 URL:
https://jihulab.com/%{project_path}/badges/%{default_branch}/pipeline.svg
- 选择 添加徽章。
群组徽章
通过向群组添加徽章,您可以为群组中的所有项目添加并强制实施项目级徽章。群组徽章在属于该组的任何项目的概览页面上可见。
虽然这些徽章在代码库中显示为项目级别的徽章,但它们不能在项目级别进行编辑或删除。
如果您需要为每个项目提供单独的徽章,则可以:
- 在项目级别添加徽章。
- 使用 placeholders。
向群组添加徽章
要将新徽章添加到群组:
- 在顶部栏上,选择 主菜单 > 群组 并找到您的群组。
- 在左侧边栏中,选择 设置 > 通用。
- 展开 徽章。
- 在“链接”下,输入徽章应指向的 URL,在“徽章图片网址”下输入应显示的图片的 URL。
- 选择 添加徽章。
将徽章添加到群组后,您可以在表单下方的列表中看到它。
编辑或删除群组徽章
要编辑徽章,请选择 编辑 ()。
要删除徽章,请选择 删除 ()。
只能在群组级别编辑或删除与群组关联的徽章。
Placeholders
徽章指向的 URL 和图片 URL 都可以包含 placeholders。可以使用以下 placeholders:
-
%{project_path}
:项目的路径,包括父组 -
%{project_title}
:项目标题 -
%{project_name}
:项目名称 -
%{project_id}
:与项目关联的数据库 ID -
%{default_branch}
:为项目仓库配置的默认分支名称 -
%{commit_sha}
:最近提交到项目仓库默认分支的 ID
Placeholders 允许徽章公开其它私有信息,例如当项目配置为具有私有仓库时的默认分支或提交 SHA。这是设计使然,因为徽章旨在公开使用。如果信息敏感,请避免使用这些 placeholders。
使用自定义徽章图片
如果您想使用默认徽章以外的徽章,请在项目或群组中使用自定义徽章图片。
先决条件:
- 直接指向所需徽章图片的有效 URL。如果图片位于极狐GitLab 仓库中,请使用图片的原始链接。
使用 placeholders,以下是一个示例徽章图片 URL,它引用仓库根目录中的原始图片:
https://gitlab.example.com/<project_path>/-/raw/<default_branch>/my-image.svg
要将新徽章添加到具有自定义图片的群组或项目:
- 在顶部栏上,选择 主菜单 并找到您的群组或项目。
- 在左侧边栏中,选择 设置 > 通用。
- 展开 徽章。
- 在 名称 下,输入徽章的名称。
- 在 链接 下,输入徽章应指向的 URL。
- 在 徽章图片网址 下,输入直接指向应显示的自定义图片的 URL。
- 选择 添加徽章。
要了解如何使用通过流水线生成的自定义图片,请参阅关于通过 URL 访问最新作业产物的文档。