파이프라인 설정 키워드 문서화

CI/CD YAML 참조 문서에서 파이프라인 설정 키워드를 일관된 스타일로 작성하고 구조화하는 방법을 설명합니다.

CI/CD YAML 구문 참조 는 사용 및 업데이트를 보다 쉽게 하기 위해 표준 스타일을 사용합니다. 참조 정보는 가능한 한 단순하게 유지해야 하며, 확장된 세부 내용과 예시는 다른 페이지에 문서화해야 합니다. YAML 참조 구조 # 모든 YAML 키워드는 참조에서 자체 섹션을 가져야 합니다. 섹션은 키워드가 논리적인 트리 구조를 따르도록 중첩되어야 합니다. 예를 들어: ### `artifacts` #### `artifacts:name` #### `artifacts:paths` #### `artifacts:reports` ##### `artifacts:reports:dast` ##### `artifacts:reports:sast` YAML 참조 스타일 # 참조의 각 키워드 항목은: 간단한 소개 섹션이 있어야 합니다. 소개에서는 키워드를 사용하는 데 필요한 기본 정보를 제공해야 합니다. 고급 세부 내용과 작업은 참조 페이지가 아닌 기능 페이지에 있어야 합니다. 키워드 이름을 제목으로 사용해야 합니다. 예를 들어: ### `artifacts` 다음 섹션을 포함해야 합니다: 키워드 유형 지원되는 값 keyword-name 예시 (선택 사항) 필요한 경우 다음 섹션도 포함할 수 있습니다: 추가 세부 내용 관련 항목 키워드 항목을 구분하기 위해 수평선( --- )을 사용해야 합니다. 키워드 이름은 항상 백틱으로 감싸되 마지막에 : 를 붙이지 않아야 합니다. 예: artifacts: 가 아닌 artifacts . 다른 키워드의 하위 키인 경우, 처음 사용할 때 artifacts:reports:dast 와 같이 "상위" 키까지의 모든 하위 키를 작성합니다. 이후에는 dast 와 같이 하위 키만 사용할 수 있습니다. 키워드 유형 # 키워드는 job 키워드 또는 글로벌 키워드일 수 있습니다. default 섹션에서 사용할 수 있는 경우에는 그 점도 명시합니다. 예를 들어: **키워드 유형**: 글로벌 키워드. **키워드 유형**: Job 키워드. job의 일부로만 사용할 수 있습니다. **키워드 유형**: Job 키워드. job의 일부로만 또는 [ default: 섹션](#default)에서만 사용할 수 있습니다. 지원되는 값 # 모든 지원되는 값과 기본값 또는 다른 GitLab 버전으로 인한 변경 사항 등 값에 대한 추가 세부 내용을 나열합니다. 예를 들어: **지원되는 값**: - `true` (정의하지 않은 경우 기본값) 또는 `false`. **지원되는 값**: - 단일 종료 코드. - 종료 코드 배열. **지원되는 값**: - 긴 설명이 포함된 문자열. - 설명이 포함된 파일의 경로. - 파일 위치는 프로젝트 디렉터리(`$CI_PROJECT_DIR`)에 대한 상대 경로여야 합니다. - 파일이 심볼릭 링크인 경우 `$CI_PROJECT_DIR` 내에 있어야 합니다. - `./path/to/file`과 파일 이름에는 공백이 포함될 수 없습니다. 키워드와 함께 사용하는 CI/CD 변수 # 키워드와 함께 CI/CD 변수를 사용할 수 있는 경우, 지원되