CI Lint API
네임스페이스에 대한 CI/CD 구성 유효성 검사
소스 브랜치에서 대상 브랜치로 변경 사항을 포함하기 위한 제안인 Merge Request(MR)입니다.
POST /projects/:id/ci/lint
속성 | 유형 | 필수 여부 | 설명 |
---|---|---|---|
content
| string | Yes | CI/CD 구성 콘텐츠입니다. |
dry_run
| boolean | No |
파이프라인 생성 시뮬레이션을 실행하거나 정적 확인만 할지 여부입니다. 기본값은 false 입니다.
|
include_jobs
| boolean | No | 응답에 정적 확인 또는 파이프라인 시뮬레이션에 포함될 작업 디렉터리이 표시되어야 하는지 여부입니다. 기본값은 false 입니다.
|
ref
| string | No |
dry_run 이 true 일 때 CI/CD YAML 구성의 유효성을 검사하는 데 사용할 브랜치 또는 태그 컨텍스트를 설정합니다. 설정되지 않은 경우 프로젝트의 기본 브랜치로 기본 설정됩니다.
|
예시 요청:
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 16.5에서 소개된
sha
속성.- GitLab 16.10에서
sha
와ref
가 각각content_ref
와dry_run_ref
로 이름이 변경되었습니다.
특정 ref(기본값은 프로젝트의 기본 브랜치의 HEAD
)의 프로젝트의 .gitlab-ci.yml
구성이 유효한지 확인합니다.
이 엔드포인트는 변수 및 로컬 include를 포함한 모든 네임스페이스별 데이터를 사용합니다.
GET /projects/:id/ci/lint
속성 | 유형 | 필수 여부 | 설명 |
---|---|---|---|
content_ref
| string | No | CI/CD 구성 콘텐츠를 가져올 커밋 SHA, 브랜치 또는 태그입니다. 설정되지 않은 경우 프로젝트의 기본 브랜치의 헤드 SHA로 기본 설정됩니다. |
dry_run_ref
| string | No |
dry_run 이 true 일 때 CI/CD YAML 구성의 유효성을 검사하는 데 사용할 브랜치 또는 태그 컨텍스트를 설정합니다. 설정되지 않은 경우 프로젝트의 기본 브랜치로 기본 설정됩니다.
|
dry_run
| boolean | No | 파이프라인 생성 시뮬레이션을 실행하거나 정적 확인만 할지 여부입니다. |
include_jobs
| boolean | No | 응답에 정적 확인 또는 파이프라인 시뮬레이션에 포함될 작업 디렉터리이 표시되어야 하는지 여부입니다. 기본값은 false 입니다.
|
ref
| string | No | (사용되지 않음) dry_run 이 true 일 때 CI/CD YAML 구성의 유효성을 검사하는 데 사용할 브랜치 또는 태그 컨텍스트를 설정합니다. 설정되지 않은 경우 프로젝트의 기본 브랜치로 기본 설정됩니다. 대신 dry_run_ref 를 사용하십시오.
|
sha
| string | No | (사용되지 않음) CI/CD 구성 콘텐츠를 가져올 커밋 SHA, 브랜치 또는 태그입니다. 설정되지 않은 경우 프로젝트의 기본 브랜치의 헤드 SHA로 기본 설정됩니다. 대신 content_ref 를 사용하십시오.
|
예시 요청:
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 인코딩해야 합니다.
YAML을 이스케이프하고 JSON 페이로드 내에 포함할 수 있는 형식으로 인코딩하려면 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
)을 이스케이프하고 인코딩하여 jq
와 curl
을 사용하여 GitLab API에 POST
하는 방법은 다음과 같습니다.
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 응답을 다시 포맷하려면 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"
한 줄의 명령으로 다음을 수행할 수 있습니다:
- YAML을 이스케이프합니다.
- JSON으로 인코딩합니다.
- curl을 사용하여 API에
POST
합니다. - 응답을 포맷합니다.
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'