{{< details >}}

  • Tier: 专业版,旗舰版
  • Offering: 私有化部署

{{< /details >}}

在托管系统中,企业通常需要在团队之间共享自己的模板。此功能允许管理员选择一个项目作为实例范围内的文件模板集合。这些模板通过 Web Editor 向所有用户公开,同时项目保持安全。

配置

要选择一个项目作为自定义模板库:

  1. 在左侧边栏底部,选择 管理员
  2. 选择 设置 > 模板
  3. 展开 模板
  4. 从下拉列表中选择要用作模板库的项目。
  5. 选择 保存更改
  6. 向选定的库添加自定义模板。

添加模板后,您可以在整个实例中使用它们。它们可在 Web Editor 中使用,也可以通过 API 设置 使用。

这些模板不能用作 .gitlab-ci.ymlinclude:template 键的值。

支持的文件类型和位置

模板必须添加到库中的特定子目录中,与模板类型相对应。支持以下类型的自定义模板:

类型 目录 扩展名
Dockerfile Dockerfile .dockerfile
.gitignore gitignore .gitignore
.gitlab-ci.yml gitlab-ci .yml
LICENSE LICENSE .txt

每个模板必须放在其相应的子目录中,具有正确的扩展名且不为空。因此,层次结构应如下所示:

|-- README.md
|-- Dockerfile
    |-- custom_dockerfile.dockerfile
    |-- another_dockerfile.dockerfile
|-- gitignore
    |-- custom_gitignore.gitignore
    |-- another_gitignore.gitignore
|-- gitlab-ci
    |-- custom_gitlab-ci.yml
    |-- another_gitlab-ci.yml
|-- LICENSE
    |-- custom_license.txt
    |-- another_license.txt

当通过极狐GitLab UI 添加新文件时,您的自定义模板会显示在下拉列表中:

The GitLab UI for creating a new file, with a dropdown list displaying the Dockerfile templates to choose from.

如果此功能被禁用或没有模板存在,则在选择下拉列表中不会显示 自定义 部分。