Help us learn about your current experience with the documentation. Take the survey.

教程：创建合规流水线（已弃用）

  • Tier: Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

此功能在 GitLab 17.3 中已弃用 并计划在 18.0 版本中移除。请改用pipeline 执行策略类型。 此更改是一个破坏性更改。有关更多信息，请参阅迁移指南。

您可以使用合规流水线来确保在组中所有项目的流水线上运行特定的合规相关作业。合规流水线通过合规框架应用于项目。

在本教程中，您将：

  1. 创建一个新组。
  2. 创建一个用于合规流水线配置的新项目。
  3. 配置一个合规框架以应用于其他项目。
  4. 创建一个新项目并对其应用合规框架。
  5. 组合合规流水线配置和常规流水线配置。

开始之前

  • 您需要创建顶级组的权限。

创建新组

合规框架在顶级组中配置。在本教程中，您将创建一个顶级组，该组：

  • 包含两个项目：
    • 用于存储合规流水线配置的合规流水线项目。
    • 另一个项目，其流水线必须运行由合规流水线配置定义的作业。
  • 拥有应用于项目的合规框架。

要创建新组：

  1. 在左侧边栏顶部，选择新建（ plus ）和新组。
  2. 选择创建组。
  3. 在组名称字段中，输入 Tutorial group。
  4. 选择创建组。

创建新的合规流水线项目

现在您可以创建合规流水线项目了。此项目包含要应用于所有已应用合规框架的项目的 合规流水线配置。

要创建合规流水线项目：

  1. 在左侧边栏，选择搜索或跳转至并找到 Tutorial group 组。
  2. 选择新项目。
  3. 选择创建空白项目。
  4. 在项目名称字段中，输入 Tutorial compliance project。
  5. 选择创建项目。

要向 Tutorial compliance project 添加合规流水线配置：

  1. 在左侧边栏，选择搜索或跳转至并找到 Tutorial compliance project 项目。

  2. 选择构建 > 流水线编辑器。

  3. 选择配置流水线。

  4. 在流水线编辑器中，将默认配置替换为：

    ---
compliance-job:
  script:
    - echo "Running compliance job required for every project in this group..."

  5. 选择提交更改。

配置合规框架

合规框架在新组中配置。

要配置合规框架：

  1. 在左侧边栏，选择搜索或跳转至并找到 Tutorial group 组。
  2. 选择安全 > 合规中心。
  3. 在页面上，选择框架标签页。
  4. 选择新框架。
  5. 在名称字段中，输入 Tutorial compliance framework。
  6. 在描述字段中，输入 Compliance framework for tutorial。
  7. 在**合规流水线配置（可选）**字段中，输入 .gitlab-ci.yml@tutorial-group/tutorial-compliance-project。
  8. 在背景颜色字段中，选择您喜欢的颜色。
  9. 选择添加框架。

为了方便，将新的合规框架设为组中所有新项目的默认框架：

  1. 在左侧边栏，选择搜索或跳转至并找到 Tutorial group 组。
  2. 选择安全 > 合规中心。
  3. 在页面上，选择框架标签页。
  4. 选择 Tutorial compliance framework，然后选择编辑框架。
  5. 选择设为默认。
  6. 选择保存更改。

创建新项目并应用合规框架

您的合规框架已准备就绪，现在您可以在组中创建项目，它们将自动在其流水线中运行 合规流水线配置。

要创建用于运行合规流水线配置的新项目：

  1. 在左侧边栏，选择搜索或跳转至并找到 Tutorial group 组。
  2. 选择新建（ plus ）和新项目/仓库。
  3. 选择创建空白项目。
  4. 在项目名称字段中，输入 Tutorial project。
  5. 选择创建项目。

在项目页面上，您会看到 Tutorial compliance framework 标签出现，因为该标签已被设为 组的默认合规框架。

在没有其他流水线配置的情况下，Tutorial project 可以运行 Tutorial compliance project 中 定义的合规流水线配置中的作业。

要在 Tutorial project 中运行合规流水线配置：

  1. 在左侧边栏，选择搜索或跳转至并找到 Tutorial project 项目。
  2. 选择构建 > 流水线。
  3. 选择新建流水线。
  4. 在新建流水线页面上，选择运行流水线。

注意，流水线在测试阶段运行了一个名为 compliance-job 的作业。干得好，您已经运行了您的第一个合规作业！

组合流水线配置

如果您希望项目运行自己的作业以及合规流水线作业，您必须组合合规 流水线配置和项目的常规流水线配置。

要组合流水线配置，您必须定义常规流水线配置，然后更新 合规流水线配置以引用它。

要创建常规流水线配置：

  1. 在左侧边栏，选择搜索或跳转至并找到 Tutorial project 项目。

  2. 选择构建 > 流水线编辑器。

  3. 选择配置流水线。

  4. 在流水线编辑器中，将默认配置替换为：

    ---
project-job:
  script:
    - echo "Running project job..."

  5. 选择提交更改。

要将新项目流水线配置与合规流水线配置组合：

  1. 在左侧边栏，选择搜索或跳转至并找到 Tutorial compliance project 项目。

  2. 选择构建 > 流水线编辑器。

  3. 在现有配置中，添加：

    include:
  - project: 'tutorial-group/tutorial-project'
    file: '.gitlab-ci.yml'

  4. 选择提交更改。

要确认常规流水线配置已与合规流水线配置组合：

  1. 在左侧边栏，选择搜索或跳转至并找到 Tutorial project 项目。
  2. 选择构建 > 流水线。
  3. 选择新建流水线。
  4. 在新建流水线页面上，选择运行流水线。

注意，流水线在测试阶段运行了两个作业：

  • compliance-job。
  • project-job。

恭喜，您已经创建并配置了一个合规流水线！

查看更多合规流水线配置示例。