콘텐츠 키
content와 sources 아래에 구성된 플레이북 키들은 콘텐츠 소스 저장소의 위치와 처리 방법을 정의합니다.
content 키
content 카테고리 키는 Antora 사이트의 콘텐츠 소스(즉, git 저장소) 목록을 포함합니다.
콘텐츠 소스는 sources 키를 사용하여 정의됩니다.
branches, tags, edit_url 키를 사용하여 모든 콘텐츠 소스에 대한 기본값을 정의할 수 있습니다.
이러한 키들은 콘텐츠 소스별로 재정의될 수 있으며, 특정 콘텐츠 소스에만 해당하는 다른 키들과 함께 사용될 수 있습니다.
content: (1)
branches: [v2.0, v2.5, v3.0] (2)
tags: [release/*, '!release/*-patch'] (3)
edit_url: '{web_url}/blob/{refname}/{path}' (4)
sources: (5)
- url: https://git-service.com/org/repo-z.git (6)
start_path: path-to/content-source-root (7)
- url: https://git-service.com/org/repo-y.git (8)| 1 | 필수 content 키 |
| 2 | 선택적 branches 키 |
| 3 | 선택적 tags 키 |
| 4 | 선택적 edit_url 키 |
| 5 | 필수 sources 키 |
| 6 | 필수 url 키 |
| 7 | 선택적 start_path 키 |
| 8 | 또 다른 url 키 |
content와 sources 키는 필수입니다.
sources 키는 적어도 하나의 url 키가 정의된 항목을 포함해야 합니다.
다른 모든 키는 선택사항입니다.
branches와 edit_url 키는 플레이북에 명시적으로 설정되지 않은 경우 Antora가 런타임에 자동으로 적용하는 내장 값을 가지고 있습니다.
content 바로 아래에 지정된 키-값 쌍은 특정 url에 해당 키가 지정되지 않은 한 sources 아래의 모든 url 키 항목에 적용됩니다.
sources 키
sources 키는 필수이며 content 키 아래에 중첩됩니다.
sources 키는 소스 항목 목록을 포함합니다.
각 항목은 하이픈으로 지정되며, git 저장소 위치(URL 또는 파일 시스템 경로), 일치시킬 브랜치 및/또는 태그 패턴, 선택적 시작 경로 또는 경로들, 그리고 Antora가 사이트 콘텐츠를 집계할 때 사용하는 기타 저장소 속성으로 구성됩니다.
content: (1)
sources: (2)
- url: https://git-service.com/org/repo-z.git (3)
branches: [v1.*, v2.*, !v1.2] (4)
start_paths: path-to/content-source-root-{item..item} (5)
- url: https://git-service.com/org/repo-y.git (6)
branches: [] (7)
tags: [release/*, '!release/*-patch'] (8)
start_path: path-to/content-source-root (9)
edit_url: '{web_url}/blob/{refname}/{path}' (10)
- url: https://git-service.com/org/repo-x.git (11)
branches: v* (12)
version: true (13)| 1 | 필수 content 키 |
| 2 | 필수 sources 키 |
| 3 | 필수 url 키 |
| 4 | 선택적 branches 키 |
| 5 | 선택적 start_paths 키 |
| 6 | 또 다른 url 키 |
| 7 | 선택적 branches 키 |
| 8 | 선택적 tags 키 |
| 9 | 선택적 start_path 키 |
| 10 | 선택적 edit_url 키 |
| 11 | 또 다른 url 키 |
| 12 | 선택적 branches 키 |
| 13 | 선택적 version 키 |
sources 키는 적어도 하나의 url 키가 정의된 항목을 포함해야 합니다.
다른 모든 키는 선택사항입니다.
branches와 edit_url 키는 플레이북에 명시적으로 정의되지 않은 경우 Antora가 런타임에 자동으로 적용하는 내장 값을 가지고 있습니다.
| 콘텐츠 소스 항목에 대해 일치하는 git 참조(브랜치 또는 태그)가 없는 경우, Antora는 정보 수준에서 메시지를 기록합니다. 이 메시지를 보려면 로그 심각도 수준을 최소한 정보 수준으로 설정해야 합니다. 디버깅을 돕기 위해 Antora의 로거를 적절히 구성하는 것을 권장합니다. |
version 키는 컴포넌트 버전 디스크립터(antora.yml)의 version 키에 대한 대체 값을 제공합니다.
단일 참조를 일치시키거나 값을 참조 이름에서 파생시키려는 경우에만 사용해야 합니다.
사용 가능한 콘텐츠 키
다음 키들은 content 키 아래에 정의될 수 있습니다.
소스 항목 자체를 포함하는 sources 키를 제외하고, 이 키들은 각 소스 항목에 대한 기본값을 제공하는 데 사용됩니다.
| 콘텐츠 키 | 설명 | 필수 여부 |
|---|---|---|
콘텐츠 소스에 지정된 저장소에서 사용할 정확한 브랜치 이름과 이름 패턴 목록을 받습니다. |
아니오 |
|
현재 페이지의 소스 뷰에 매핑되는 URL을 구축하기 위한 URL 패턴을 받습니다.
다음 플레이스홀더 세그먼트를 수용합니다: |
아니오 |
|
콘텐츠로 사용할 저장소와 저장소 참조를 지정하는 콘텐츠 소스 항목 목록을 받습니다. |
예 |
|
콘텐츠 소스에 지정된 저장소에서 사용할 정확한 태그 이름과 이름 패턴 목록을 받습니다. |
아니오 |
사용 가능한 콘텐츠 소스 키
| 콘텐츠 키 | 설명 | 필수 여부 |
|---|---|---|
콘텐츠 소스에 지정된 저장소에서 사용할 정확한 브랜치 이름과 이름 패턴 목록을 받습니다.
지정되지 않은 경우 |
아니오 |
|
현재 페이지의 소스 뷰에 매핑되는 URL을 구축하기 위한 URL 패턴을 받습니다.
다음 플레이스홀더 세그먼트를 수용합니다: |
아니오 |
|
저장소에서 콘텐츠 소스 루트 위치까지의 상대 경로를 지정합니다. |
아니오 |
|
콘텐츠 소스 루트 위치에 대한 저장소 상대 경로 패턴 목록을 받습니다. 정확한 경로나 셸 글로브 패턴으로 지정할 수 있습니다. 단일 값은 배열로 강제 변환됩니다. |
아니오 |
|
콘텐츠 소스에 지정된 저장소에서 사용할 정확한 태그 이름과 이름 패턴 목록을 받습니다. |
아니오 |
|
git 저장소의 URL을 받습니다. HTTPS URL이나 로컬 파일 시스템 경로일 수 있습니다. |
예 |
|
일치하는 모든 참조에 대해 컴포넌트 버전 디스크립터의 |
아니오 |
|
Antora가 사용해야 하는 해당 작업 트리를 제어하기 위한 키워드나 정확한 브랜치 이름 또는 이름 패턴 목록을 받습니다. |
아니오 |