Code Owners 구문 및 오류 처리

Tier: Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

이 페이지에서는 Code Owners 파일에서 사용되는 구문 및 오류 처리를 설명하고, 예제 파일을 제공합니다.

Code Owners 구문

주석

#으로 시작하는 줄은 무시됩니다: 

# 이것은 주석입니다

섹션

섹션은 항목들의 그룹입니다. 섹션은 섹션 헤딩으로 시작하여 항목들이 뒤따릅니다. 

[섹션 이름]
/path/of/protected/file.rb @username
/path/of/protected/dir/ @group

섹션 헤딩

섹션 헤딩은 항상 이름을 가져야 합니다. 선택 사항으로 만들거나 승인 수를 요구할 수 있습니다. 섹션 헤딩 라인에 기본 소유자 목록을 추가할 수 있습니다. 

# 필수 섹션
[섹션 이름]

# 선택 사항 섹션
^[섹션 이름]

# 5개의 승인이 필요한 섹션
[섹션 이름][5]

# 기본 소유자로 @username이 있는 섹션
[섹션 이름] @username

# 기본 소유자로 @group 및 @subgroup이 있으며 2개의 승인이 필요한 섹션
[섹션 이름][2] @group @subgroup

섹션 이름

섹션 이름은 대괄호로 정의됩니다. 섹션 이름은 대소문자를 구분하지 않습니다. 중복된 이름을 갖는 섹션들은 결합됩니다. 

[섹션 이름]

필수 섹션

필수 섹션에는 ^가 섹션 이름(섹션 이름) 앞에 포함되지 않습니다. 

[필수 섹션]

선택 사항 섹션

선택 사항 섹션에는 섹션 이름(섹션 이름) 앞에 ^가 포함됩니다. 

^[선택 사항 섹션]

여러 승인이 필요한 섹션

여러 승인이 필요한 섹션에는 섹션 이름(섹션 이름) 뒤에 대괄호 안에 승인 수가 포함됩니다. 

[5개의 승인이 필요한 섹션][5]

참고: 선택 사항 섹션에는 필요한 승인 수가 무시됩니다.

기본 소유자가 있는 섹션

섹션의 항목들에 대한 기본 소유자를 섹션 헤딩(섹션 헤딩)에 추가하여 정의할 수 있습니다. 

# 기본 소유자로 @username이 있는 섹션
[섹션 이름] @username

# 기본 소유자로 @group 및 @subgroup이 있으며 2개의 승인이 필요한 섹션
[섹션 이름][2] @group @subgroup

Code Owner 항목들

각 Code Owner 항목에는 하나 이상의 소유자를 포함합니다. 

README.md @username1

참고: 섹션 내에서 항목이 중복되면, 각 섹션의 마지막 항목이 사용됩니다.

상대적인 경로

경로가 /로 시작하지 않는 경우, 해당 경로는 globstar로 시작하는 것으로 취급됩니다. README.md는 /**/README.md와 동일하게 처리됩니다. 

# /README.md, /internal/README.md, /app/lib/README.md에 일치합니다
README.md @username
 
# /internal/README.md, /docs/internal/README.md, /docs/api/internal/README.md에 일치합니다
internal/README.md

절대 경로

경로가 /로 시작하면 저장소의 루트와 일치합니다. 

# 저장소 루트에 있는 'README.md'파일에만 일치합니다
/README.md

# '/docs' 디렉토리 안의 'README.md'파일에만 일치합니다
/docs/README.md

디렉터리 경로

경로가 /로 끝나면 해당 디렉토리의 모든 파일과 일치합니다. 

# 이것은 `/docs/**/*`와 동일합니다
/docs/

와일드카드 경로

와일드카드는 경로의 하나 이상의 문자와 일치하는 데 사용될 수 있습니다. 

# `docs` 디렉토리의 모든 markdown 파일에 일치합니다
/docs/*.md @username
 
# 모든 파일이름이 'index'인 `/docs/index`파일에 일치합니다
# 예: /docs/index.md, /docs/index.html, /docs/index.xml
/docs/index.* @username
 
# 이름에 'spec'이 포함된 모든 파일이 `/docs` 디렉토리에 일치합니다.
# 예: /docs/qa_specs.rb, /docs/spec_helpers.rb, /docs/runtime.spec
/docs/*spec* @username
 
# `docs`디렉토리에서 한 수준 아래에 있는 'README.md'파일에 일치합니다
# 예: /docs/api/README.md
/docs/*/README.md @username

Globstar 경로

Globstar (**)는 제로 또는 그 이상의 디렉토리와 서브디렉토리와 일치하는 데 사용될 수 있습니다. 

# 이것은 /docs/index.md, /docs/api/index.md, /docs/api/graphql/index.md와 일치합니다
/docs/**/index.md

항목 소유자

항목은 하나 이상의 소유자로 이루어져야 합니다. 이들은 그룹, 서브그룹, 사용자일 수 있습니다. 소유자의 순서는 중요하지 않습니다. 

/path/to/entry.rb @group
/path/to/entry.rb @group/subgroup
/path/to/entry.rb @user
/path/to/entry.rb @group @group/subgroup @user

항목 소유자로서의 그룹

그룹 및 서브그룹은 항목의 소유자가 될 수 있습니다. 각 항목은 하나 이상의 소유자로 소유될 수 있습니다. 더 자세한 내용은 그룹을 Code Owner로 추가를 참조하세요. 

/path/to/entry.rb @group
/path/to/entry.rb @group/subgroup
/path/to/entry.rb @group @group/subgroup

사용자별 엔트리 소유자

사용자는 엔트리의 소유자가 될 수 있습니다. 각 엔트리는 하나 이상의 소유자가 소유할 수 있습니다. 

/path/to/entry.rb @username1
/path/to/entry.rb @username1 @username2

코드 소유자의 오류 처리

공백이 포함된 엔트리

공백을 포함하는 경로는 백 슬래시로 이스케이프 처리해야 합니다: path\ with\ spaces/*.md. 백 슬래시 없이 첫 번째 공백 이후의 경로는 소유자로 구문 분석됩니다. GitLab은 folder with spaces/*.md @group을 다음과 같이 구문 분석합니다. path: "folder", owners: " with spaces/*.md @group".

구문 분석할 수 없는 섹션들

제목을 구문 분석할 수 없는 경우, 해당 섹션은 다음과 같이 처리됩니다:

  1. 엔트리로 구문 분석됨.
  2. 이전 섹션에 추가됨.
  3. 이전 섹션이 없을 경우, 기본 섹션에 추가됨.

예를 들어, 이 파일은 닫힌 대괄호가 누락되었습니다. 

* @group

[Section name
docs/ @docs_group

GitLab은 [Section name 제목을 엔트리로 인식합니다. 기본 섹션에는 3가지 규칙이 포함됩니다:

  • 기본 섹션
    • *이 @group에 의해 소유됨
    • [Section이 name에 의해 소유됨
    • docs/가 @docs_group에 의해 소유됨

이 파일은 Section과 name 사이에 이스케이프되지 않은 공백을 포함합니다. GitLab은 의도된 제목을 엔트리로 인식합니다. 

[Docs]
docs/**/* @group

[Section name]{2} @group
docs/ @docs_group

[Docs] 섹션에는 3가지 규칙이 포함됩니다:

  • docs/**/*이 @group에 의해 소유됨
  • [Section이 name]{2} @group에 의해 소유됨
  • docs/가 @docs_group에 의해 소유됨

잘못된 형식의 소유자

유효한 엔트리는 1명 이상의 소유자를 포함해야 하며, 잘못된 형식의 소유자는 무시됩니다. 예를 들어, /path/* @group user_without_at_symbol @user_with_at_symbol은 @group과 @user_with_at_symbol에 의해 소유됩니다.

접근할 수 없거나 잘못된 소유자

접근할 수 없거나 잘못된 소유자는 무시됩니다. 예를 들어, @group, @username, example@gitlab.com이 프로젝트에서 접근 가능하고 다음과 같은 엔트리를 생성하는 경우: 

* @group @grou @username @i_left @i_dont_exist example@gitlab.com invalid@gitlab.com

GitLab은 @grou, @i_left, @i_dont_exist, invalid@gitlab.com을 무시합니다.

접근 가능한 소유자에 대한 자세한 정보는 코드 소유자로 그룹 추가를 참조하세요.

소유자가 없는 경우

엔트리에 소유자가 포함되지 않거나 접근할 수 없는 소유자가 존재하지 않는 경우, 해당 엔트리는 유효하지 않습니다. 이 규칙은 절대 충족될 수 없으므로 GitLab은 병합 요청에서 자동으로 승인합니다.

참고: 보호된 브랜치가 소유자 승인 필요를 활성화한 경우, 소유자가 없는 규칙은 여전히 적용됩니다.

필요한 승인 횟수가 1 미만인 경우

섹션의 승인 횟수를 정의할 때, 최소 승인 횟수는 1입니다. 승인 횟수를 0으로 설정하면 GitLab은 한 번의 승인을 요구합니다.

CODEOWNERS 파일 예시 

# 이것은 CODEOWNERS 파일의 예시입니다.
# `#`로 시작하는 라인은 무시됩니다.

# app/ @commented-rule

# 와일드카드를 사용하여 기본 코드 소유자 지정:
* @default-codeowner

# 탭이나 공백을 사용하여 여러 코드 소유자 지정:
* @multiple @code @owners

# 파일 내용이 도입 전에 정의된 규칙보다 우선순위를 갖습니다.
# 예를 들어, .rb로 끝나는 모든 파일에 대해:
*.rb @ruby-owner

# `#`가 포함된 파일에 액세스하려면 샵 기호를 이스케이프 처리할 수 있습니다:
\#file_with_pound.rb @owner-file-with-pound

# 여러 코드 소유자를 공백이나 탭으로 구분하여 지정합니다.
# 다음 케이스에서 리포지토리 루트의 CODEOWNERS 파일에는 3명의 코드 소유자(@multiple @code @owners)가 지정되어 있습니다:
CODEOWNERS @multiple @code @owners

# 사용자 이름이나 이메일 주소를 사용하여 일치시킬 수 있습니다.
# 그 외 모든 것은 무시됩니다. 예를 들어, 코드로는 `@legal`과 이메일이 `janedoe@gitlab.com`인 사용자를 
# LICENSE 파일의 소유자로 지정합니다:
LICENSE @legal this_does_not_match janedoe@gitlab.com

# 그룹 이름을 사용하여 그룹을 일치시키고 중첩된 그룹을 지정하여 
# 파일의 소유자로 지정할 수 있습니다:
README @group @group/with-nested/subgroup

# 디렉토리의 끝에 `/`를 지정하여 해당 디렉토리에 중첩된 모든 수준의 모든 파일의 
# 코드 소유자를 지정할 수 있습니다:
/docs/ @all-docs

# `/*`로 경로를 끝내면 해당 디렉토리에 중첩되지 않은 모든 파일에 대한 
# 코드 소유자를 지정할 수 있습니다. 이 코드는 `docs/index.md`에는 일치하지만 `docs/projects/index.md`에는 일치하지 않습니다:
/docs/* @root-docs

# `/**`를 포함하여 디렉토리의 모든 하위 디렉토리에 대한 코드 소유자를 지정할 수 있습니다.
# 이 규칙은 `docs/projects/index.md` 또는 `docs/development/index.md`에 일치합니다
/docs/**/*.md @root-docs

# 이 코드는 리포지토리의 어디에 있든지 중첩된 `lib` 디렉토리와 일치합니다:
lib/ @lib-owner

# 이 코드는 리포지토리의 루트에 있는 `config` 디렉토리에 일치합니다:
/config/ @config-owner

# 경로에 공백이 포함된 경우 다음과 같이 이스케이프 처리합니다:
path\ with\ spaces/ @space-owner

# 코드 소유자 섹션:
[Documentation]
ee/docs    @docs
docs       @docs

# 섹션에 대한 기본 소유자의 사용. 이 경우 (*) 모든 파일은 
# dev 팀에 의해 소유되지만 README.md와 data-models는 다른 팀에 의해 소유됩니다.
[Development] @dev-team
*
README.md @docs-team
data-models/ @data-science-team

# 이 섹션은 이전에 정의된 [Documentation] 섹션과 결합됩니다:
[DOCUMENTATION]
README.md  @docs