badges.md 2.6 KB
Newer Older
Lab机器人's avatar
Lab机器人 已提交
1
# 徽章[](#badges "Permalink")
Lab机器人's avatar
readme  
Lab机器人 已提交
2

Lab机器人's avatar
Lab机器人 已提交
3
徽章是呈现有关您的项目的简要信息的统一方法,它们由一个小图像以及该图像指向的 URL 组成。徽章的示例可以是 pipeline 状态、测试范围或项目维护者联系的方式等。
Lab机器人's avatar
readme  
Lab机器人 已提交
4

Lab机器人's avatar
Lab机器人 已提交
5
## 项目徽章[](#project-badges "Permalink")
Lab机器人's avatar
readme  
Lab机器人 已提交
6

Lab机器人's avatar
Lab机器人 已提交
7
维护者或所有者可以将徽章添加到项目中,然后在项目的首页可见。如果发现必须将相同的徽标添加到多个项目,则可能需要在[组级别](#group-badges)添加它们。
Lab机器人's avatar
readme  
Lab机器人 已提交
8

Lab机器人's avatar
Lab机器人 已提交
9
可以通过以下步骤将新徽章添加到项目:
Lab机器人's avatar
readme  
Lab机器人 已提交
10

Lab机器人's avatar
Lab机器人 已提交
11 12 13
1.  进入项目的**项目设置>通用设置>徽章** 
2.  输入徽章的名称,在"链接"下,输入徽章应指向的 URL,在"徽章图像 URL"下输入应显示的图像的 URL
3.  点击**添加徽章**按钮来提交**徽章**
Lab机器人's avatar
readme  
Lab机器人 已提交
14

Lab机器人's avatar
Lab机器人 已提交
15
将徽章添加到项目后,您可以在表单下方的列表中看到它,您可以通过单击旁边的图标进行编辑,也可以通过单击删除图标将其删除。
Lab机器人's avatar
readme  
Lab机器人 已提交
16

Lab机器人's avatar
Lab机器人 已提交
17
与组关联的徽章只能在[组级别](#group-badges)上进行编辑或删除。
Lab机器人's avatar
readme  
Lab机器人 已提交
18

Lab机器人's avatar
Lab机器人 已提交
19
## 组织徽章[](#group-badges "Permalink")
Lab机器人's avatar
readme  
Lab机器人 已提交
20

Lab机器人's avatar
Lab机器人 已提交
21
可以将徽章添加到组织中,然后将在该组下的每个项目的页面上看到它们。在这种情况下,无法在项目级别上对其进行编辑或删除,如果每个项目需要单独的徽章,请考虑将其添加到[项目级别](#project-badges)或使用[占位符](#placeholders)
Lab机器人's avatar
readme  
Lab机器人 已提交
22

Lab机器人's avatar
Lab机器人 已提交
23
可以通过以下步骤将新徽章添加到组织:
Lab机器人's avatar
readme  
Lab机器人 已提交
24

Lab机器人's avatar
Lab机器人 已提交
25 26 27
1.  进入组织的**组织设置>常规设置>徽章**
2.  输入徽章的名称,在"链接"下,输入徽章应指向的 URL,在"徽章图像 URL"下输入应显示的图像的 URL
3.  点击**添加徽章**按钮来提交**徽章**
Lab机器人's avatar
readme  
Lab机器人 已提交
28

Lab机器人's avatar
Lab机器人 已提交
29
将徽章添加到组后,您可以在表格下方的列表中看到它。您可以通过单击徽章旁边的图标来编辑徽章,也可以通过单击删除图标来删除徽章。
Lab机器人's avatar
readme  
Lab机器人 已提交
30

Lab机器人's avatar
Lab机器人 已提交
31
与项目直接关联的徽章可以在[项目级别](#project-badges)上配置。
Lab机器人's avatar
readme  
Lab机器人 已提交
32

Lab机器人's avatar
Lab机器人 已提交
33
## 占位符[](#placeholders "Permalink")
Lab机器人's avatar
readme  
Lab机器人 已提交
34

Lab机器人's avatar
Lab机器人 已提交
35
徽章指向的 URL 以及图像 URL 可以包含占位符,在显示徽章时将根据设置占位符来变化。可以使用的占位符包括:
Lab机器人's avatar
readme  
Lab机器人 已提交
36

Lab机器人's avatar
Lab机器人 已提交
37 38 39 40
*   `%{project_path}` :包含父组织的项目的路径
*   `%{project_id}` :数据库中与项目关联的 ID
*   `%{default_branch}` :为项目代码仓库配置的默认分支名称
*   `%{commit_sha}` :项目代码仓库中默认分支的最新提交 ID
Lab机器人's avatar
readme  
Lab机器人 已提交
41

Lab机器人's avatar
Lab机器人 已提交
42
**注意:** 占位符允许徽章公开其他隐私信息,例如私有项目仓库中的默认分支名称或提交 SHA。这样设计师因为徽章是用来公开使用的,对于敏感的信息,请尽量避免使用这些占位符。