• 验证 CI YAML 配置
  • YAML 扩展
• 使用命名空间验证 CI YAML 配置
• 验证项目的 CI 配置
• 使用 jq 创建并处理 YAML & JSON 负载
  • 为 JSON 编码进行转义
  • 解析 CI Lint 响应

CI Lint API

验证 CI YAML 配置

检查 CI/CD YAML 配置是否有效。此端点验证基本的 CI/CD 配置语法。没有任何特定于命名空间的上下文。

当实例允许新注册时，访问此端点不需要身份验证。 并且：

• 没有允许列表或拒绝列表
• 不存在新注册需要管理员批准
• 没有额外的注册限制

否则，需要进行身份验证。

POST /ci/lint

curl --header "Content-Type: application/json" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/ci/lint" --data '{"content": "{ \"image\": \"ruby:2.6\", \"services\": [\"postgres\"], \"before_script\": [\"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}"}'

YAML 对缩进和间距非常敏感，请务必粘贴极狐GitLab CI/CD YAML 配置的准确内容。

响应示例：

• 有效内容：

  {
    "status": "valid",
    "errors": [],
    "warnings": []
  }
  

• 带有告警的有效内容：

  {
    "status": "valid",
    "errors": [],
    "warnings": ["jobs:job may allow multiple pipelines to run for a single action due to
    `rules:when` clause with no `workflow:rules` - read more:
    https://docs.gitlab.com/ee/ci/troubleshooting.html#pipeline-warnings"]
  }
  

• 无效内容：

  {
    "status": "invalid",
    "errors": [
      "variables config should be a hash of key value pairs"
    ],
    "warnings": []
  }
  

• 没有内容属性：

  {
    "error": "content is missing"
  }
  

YAML 扩展

引入于极狐GitLab 13.5。

CI Lint 返回配置的扩展版本。扩展对于添加了 include: local 的 CI 配置不起作用，并且不完全支持 extends: 关键字。

将使用 include_merged_yaml 和 include_jobs 传递给 CI Lint API 的 .gitlab-ci.yml 示例内容设置为 True：

include:
  remote: 'https://example.com/remote.yaml'

test:
  stage: test
  script:
    - echo 1

https://example.com/remote.yaml 示例内容：

another_test:
  stage: test
  script:
    - echo 2

响应示例：

{
  "status": "valid",
  "errors": [],
  "merged_yaml": "---\n:another_test:\n  :stage: test\n  :script: echo 2\n:test:\n  :stage: test\n  :script: echo 1\n",
  "jobs": [
    {
      "name":"test",
      "stage":"test",
      "before_script":[],
      "script":["echo 1"],
      "after_script":[],
      "tag_list":[],
      "environment":null,
      "when":"on_success",
      "allow_failure":false,
      "only":{
        "refs":["branches","tags"]
      },
      "except":null
    },
    {
      "name":"another_test",
      "stage":"test",
      "before_script":[],
      "script":["echo 2"],
      "after_script":[],
      "tag_list":[],
      "environment":null,
      "when":"on_success",
      "allow_failure":false,
      "only":{
        "refs":["branches","tags"]
      },
      "except":null
    }
  ]
}

使用命名空间验证 CI YAML 配置

引入于极狐GitLab 13.6。

检查 CI/CD YAML 配置是否有效。该端点拥有命名空间指定的上下文。

POST /projects/:id/ci/lint

请求示例：

curl --header "Content-Type: application/json" "https://gitlab.example.com/api/v4/projects/:id/ci/lint" --data '{"content": "{ \"image\": \"ruby:2.6\", \"services\": [\"postgres\"], \"before_script\": [\"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}"}'

响应示例：

• 有效配置：

  {
    "valid": true,
    "merged_yaml": "---\n:test_job:\n  :script: echo 1\n",
    "errors": [],
    "warnings": []
  }
  

• 无效配置：

  {
    "valid": false,
    "merged_yaml": "---\n:test_job:\n  :script: echo 1\n",
    "errors": [
      "jobs config should contain at least one visible job"
    ],
    "warnings": []
  }
  

验证项目的 CI 配置

引入于极狐GitLab 13.5。

检查项目最新的（项目默认分支的HEAD） .gitlab-ci.yml 配置是否有效。 此端点使用所有可用的命名空间指定的数据，包括变量和本地包含。

GET /projects/:id/ci/lint

请求示例：

curl "https://gitlab.example.com/api/v4/projects/:id/ci/lint"

响应示例：

• 有效配置：

{
  "valid": true,
  "merged_yaml": "---\n:test_job:\n  :script: echo 1\n",
  "errors": [],
  "warnings": []
}

• 无效配置：

{
  "valid": false,
  "merged_yaml": "---\n:test_job:\n  :script: echo 1\n",
  "errors": [
    "jobs config should contain at least one visible job"
  ],
  "warnings": []
}

使用 jq 创建并处理 YAML & JSON 负载

要将 YAML 配置 POST 到 CI Lint 端点，必须对其进行正确转义和 JSON 编码。 您可以使用 jq 和 curl 转义 YAML 并将其上传到极狐GitLab API。

为 JSON 编码进行转义

转义引号并在 JSON 负载中以适合嵌入的格式对 YAML 进行编码，您可以使用 jq。例如，创建一个名为 example-gitlab-ci.yml 的文件：

.api_test:
  rules:
    - if: $CI_PIPELINE_SOURCE=="merge_request_event"
      changes:
        - src/api/*
deploy:
  extends:
    - .api_test
  rules:
    - when: manual
      allow_failure: true
  script:
    - echo "hello world"

使用 jq 进行转义并将 YAML 文件编码为 JSON：

jq --raw-input --slurp < example-gitlab-ci.yml

要转义和编码输入 YAML 文件（example-gitlab-ci.yml），并在单行命令中使用 curl 和 jq 将其 POST 到极狐GitLab API：

jq --null-input --arg yaml "$(<example-gitlab-ci.yml)" '.content=$yaml' \
| curl "https://gitlab.com/api/v4/ci/lint?include_merged_yaml=true" \
--header 'Content-Type: application/json' \
--data @-

解析 CI Lint 响应

要重定 CI Lint 响应的格式，您可以使用 jq。您可以将 CI Lint 响应通过管道传输到 jq，或将 API 响应存储为文本文件并将其作为参数提供：

jq --raw-output '.merged_yaml | fromjson' <your_input_here>

输入示例：

{"status":"valid","errors":[],"merged_yaml":"---\n:.api_test:\n  :rules:\n  - :if: $CI_PIPELINE_SOURCE==\"merge_request_event\"\n    :changes:\n    - src/api/*\n:deploy:\n  :rules:\n  - :when: manual\n    :allow_failure: true\n  :extends:\n  - \".api_test\"\n  :script:\n  - echo \"hello world\"\n"}

变成：

:.api_test:
  :rules:
  - :if: $CI_PIPELINE_SOURCE=="merge_request_event"
    :changes:
    - src/api/*
:deploy:
  :rules:
  - :when: manual
    :allow_failure: true
  :extends:
  - ".api_test"
  :script:
  - echo "hello world"

您可以使用单行命令：

1. 转义 YAML
2. 用 JSON 编码
3. 使用 curl 将其 POST 为 API
4. 设定响应的格式

jq --null-input --arg yaml "$(<example-gitlab-ci.yml)" '.content=$yaml' \
| curl "https://gitlab.com/api/v4/ci/lint?include_merged_yaml=true" \
--header 'Content-Type: application/json' --data @- \
| jq --raw-output '.merged_yaml | fromjson'