CI Lint API

네임스페이스의 CI/CD 구성 유효성 검사

소스 브랜치에서 대상 브랜치로 변경 내용을 통합하는 제안입니다. 이 엔드포인트는 네임스페이스별 컨텍스트를 가지고 있습니다.

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 구성 유효성 검사

• sha 속성은 GitLab 16.5에서 도입되었습니다.
• sha 및 ref은 GitLab 16.10에서 content_ref 및 dry_run_ref로 이름이 변경되었습니다.

주어진 ref(기본값은 프로젝트의 기본 브랜치의 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": []
}

YAML 및 JSON 데이터 페이로드를 생성하고 처리하기 위해 jq 사용하기

CI Lint 엔드포인트에 YAML 구성을 POST 하려면 적절하게 이스케이프하여 JSON으로 인코딩해야 합니다. jq와 curl을 사용하여 YAML을 이스케이프하고 GitLab API에 업로드할 수 있습니다.

JSON 인코딩을 위한 YAML 이스케이프

따옴표를 이스케이프하고 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

example-gitlab-ci.yml 입력 YAML 파일을 이스케이프하고 인코딩하여 GitLab API에 POST하는 방법은 아래와 같습니다. 이를 위해 curl과 jq를 사용하여 한 줄의 명령을 실행합니다:

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을 사용하여 API에 POST
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'