• 이슈 템플릿 생성
• Merge Request 템플릿 생성
• 템플릿 사용
  • Merge Request 템플릿에서 지원되는 변수
  • 인스턴스 수준의 설명 템플릿 설정
  • 그룹 수준의 설명 템플릿 설정
  • 이슈와 Merge Request의 기본 템플릿 설정
    • 기본 설명 템플릿의 우선 순위
• 설명 템플릿 예제

설명 템플릿

이슈 및 Merge Request에 사용할 템플릿을 정의할 수 있습니다.

프로젝트, 그룹 또는 인스턴스에서 이러한 템플릿을 정의할 수 있습니다. 프로젝트는 상위 수준에서 정의된 템플릿을 상속합니다.

다음과 같은 템플릿을 사용할 수 있습니다:

• 워크플로의 각 단계별로(예: 기능 제안, 기능 개선, 버그 보고서).
• 특정 프로젝트의 모든 이슈나 Merge Request에 대한 레이아웃이 일관되도록.
• 서비스 데스크 이메일 템플릿에 대해.

설명 템플릿이 작동하려면:

• .md 확장명으로 저장되어야 합니다.
• 프로젝트의 리포지터리에 .gitlab/issue_templates 또는 .gitlab/merge_request_templates 디렉터리에 저장되어 있어야 합니다.
• 기본 브랜치에 존재해야 합니다.

이슈 템플릿 생성

리포지터리 내의 .gitlab/issue_templates/ 디렉터리에 새로운 Markdown(.md) 파일을 생성합니다.

이슈 설명 템플릿을 생성하려면:

1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
2. Code > 리포지터리를 선택합니다.
3. 기본 브랜치 옆에 를 선택합니다.
4. New file을 선택합니다.
5. 기본 브랜치 옆에 파일 이름 텍스트 상자에 .gitlab/issue_templates/mytemplate.md를 입력하고, 여기서 mytemplate은 이슈 템플릿의 이름입니다.
6. 기본 브랜치에 커밋합니다.

이것이 올바르게 작동했는지 확인하려면 새로운 이슈를 만들어 템플릿 선택 드롭다운 디렉터리에서 설명 템플릿을 찾을 수 있는지 확인하세요.

Merge Request 템플릿 생성

이슈 템플릿과 유사하게 리포지터리의 .gitlab/merge_request_templates/ 디렉터리에 새로운 Markdown(.md) 파일을 생성합니다. 이슈 템플릿과 달리 Merge Request은 추가적인 상속 규칙이 있으며, 이는 커밋 메시지와 브랜치 이름 내용에 따라 다릅니다.

프로젝트에 대한 Merge Request 설명 템플릿을 생성하려면:

1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
2. Code > 리포지터리를 선택합니다.
3. 기본 브랜치 옆에 를 선택합니다.
4. New file을 선택합니다.
5. 기본 브랜치 옆에 파일 이름 텍스트 상자에 .gitlab/merge_request_templates/mytemplate.md를 입력하고, 여기서 mytemplate은 Merge Request 템플릿의 이름입니다.
6. 기본 브랜치에 커밋합니다.

이것이 올바르게 작동했는지 확인하려면 새로운 Merge Request을 만들어 템플릿 선택 드롭다운 디렉터리에서 설명 템플릿을 찾을 수 있는지 확인하세요.

템플릿 사용

이슈나 Merge Request을 생성 또는 편집할 때 템플릿 선택 드롭다운 디렉터리에 표시됩니다.

템플릿을 적용하려면:

1. 이슈나 Merge Request을 생성하거나 편집합니다.
2. 템플릿 선택 드롭다운 디렉터리을 선택합니다.
3. Description 텍스트 상자가 비어 있지 않다면 확인하려면 템플릿 적용을 선택합니다.
4. 저장을 선택합니다.

설명 템플릿을 선택하면 해당 템플릿의 내용이 설명 텍스트 상자에 복사됩니다.

템플릿을 선택한 후 설명을 변경한 경우, 템플릿 선택 드롭다운 디렉터리을 확장하고 템플릿 재설정을 선택해 변경 사항을 취소할 수 있습니다.

Merge Request 템플릿에서 지원되는 변수

• GitLab 15.7에서 도입됨.

첫 번째 Merge Request을 저장할 때, GitLab은 Merge Request 템플릿에서 이러한 변수를 해당 값으로 바꿉니다:

인스턴스 수준의 설명 템플릿 설정

인스턴스 템플릿 리포지터리를 사용하여 이슈와 Merge Request에 대한 인스턴스 수준 설명 템플릿을 설정할 수 있습니다. 파일 템플릿에도 인스턴스 템플릿 리포지터리를 사용할 수 있습니다.

인스턴스 내에 새 프로젝트를 생성할 때 사용할 수 있는 프로젝트 템플릿에도 관심이 있을 수 있습니다.

그룹 수준의 설명 템플릿 설정

그룹 수준 설명 템플릿을 사용하면 템플릿을 저장할 그룹 내의 프로젝트를 선택할 수 있습니다. 그런 다음, 해당 그룹의 다른 프로젝트에서 이러한 템플릿에 액세스할 수 있습니다. 결과적으로 모든 그룹 프로젝트의 이슈 및 Merge Request에 동일한 템플릿을 사용할 수 있습니다.

전제 조건:

• 그룹에 대한 소유자 역할이 있어야 합니다.
• 프로젝트는 그룹의 직접적인 자식이어야 합니다.

생성한 템플릿을 재사용하려면:

1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 그룹을 찾습니다.
2. 설정 > 일반을 선택합니다.
3. 템플릿을 확장합니다.
4. 드롭다운 디렉터리에서 템플릿 리포지터리로써 템플릿 프로젝트를 선택합니다.
5. 저장을 선택합니다.

다음과 같은 그룹 내 파일 유형에 대한 템플릿에도 관심이 있을 수 있습니다.

이슈와 Merge Request의 기본 템플릿 설정

프로젝트에서 새 이슈와 Merge Request에 대한 기본 설명 템플릿을 선택할 수 있습니다. 결과적으로 새로운 Merge Request이나 이슈가 생성될 때마다 템플릿에 입력한 텍스트가 미리 채워져 있습니다.

전제 조건:

• 프로젝트의 왼쪽 사이드바에서 설정 > 일반을 선택하고 가시성, 프로젝트 기능, 권한을 확장합니다. 이슈나 Merge Request은 모두 접근 가능한 사용자 또는 프로젝트 멤버만으로 설정되어 있어야 합니다.

Merge Request에 대한 기본 설명 템플릿을 설정하려면:

• .gitlab/merge_request_templates/에 Default.md (대소문자 무시)라는 이름으로 Merge Request 템플릿을 생성해 저장합니다. 이를 통해 프로젝트 설정에 이미 기본 템플릿이 설정되어 있지 않다면 기본 템플릿의 우선 순위가 높아지지 않습니다.

• GitLab Premium 및 Ultimate 사용자: 프로젝트 설정에서 기본 템플릿을 설정합니다:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > Merge Request을 선택합니다.
  3. Merge Request에 대한 기본 설명 템플릿 섹션에서 텍스트 영역을 채웁니다.
  4. 저장을 선택합니다.

이슈에 대한 기본 설명 템플릿을 설정하려면:

• .gitlab/issue_templates/에 Default.md (대소문자 무시)라는 이름으로 이슈 템플릿을 생성해 저장합니다. 이를 통해 프로젝트 설정에 이미 기본 템플릿이 설정되어 있지 않다면 기본 템플릿의 우선 순위가 높아지지 않습니다.

• GitLab Premium 및 Ultimate 사용자: 프로젝트 설정에서 기본 템플릿을 설정합니다:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > 일반을 선택합니다.
  3. 이슈에 대한 기본 설명 템플릿을 확장합니다.
  4. 텍스트 영역을 채웁니다.
  5. 저장을 선택합니다.

GitLab Merge Request 및 이슈는 Markdown을 지원하므로 제목, 디렉터리 등을 서식 지정하는 데 사용할 수 있습니다.

Projects REST API에서 issues_template 및 merge_requests_template 속성을 제공하여 기본 이슈 템플릿과 Merge Request 템플릿을 최신으로 유지할 수도 있습니다.

기본 설명 템플릿의 우선 순위

다양한 위치에 이슈 설명 템플릿을 설정할 때 프로젝트 내에서 다음과 같은 우선 순위가 있습니다.
우선 순위가 높은 것이 아래의 것을 덮어씁니다.

1. 프로젝트 설정에 설정된 템플릿.
2. 상위 그룹에서의 Default.md (대소문자 구분하지 않음).
3. 프로젝트 리포지터리에서의 Default.md (대소문자 구분하지 않음).

Merge Request은 추가적인 상속 규칙을 가지며, 커밋 메시지와 브랜치 이름에 따라 달라집니다.

설명 템플릿 예제

우리는 GitLab 프로젝트의 .gitlab 폴더에서 이슈와 Merge Request에 대한 설명 템플릿을 사용하며, 여기에서 몇 가지 예제를 참고할 수 있습니다.

다음은 버그 리포트 템플릿의 예시입니다:

## 요약

(간결하게 발생한 버그 요약)

## 재현 방법

(이 문제를 재현하는 방법 - 매우 중요합니다)

## 예제 프로젝트

(가능한 경우, 여기에서 문제가 발생하는 예제 프로젝트를 GitLab.com에 생성하고 여기에 링크를 제시하세요.
이전 버전의 GitLab을 사용 중이라면 이로부터 버그가 최신 버전에서 수정되었는지도 확인할 수 있습니다)

## 현재 버그 동작

(실제로 발생하는 일)

## 기대하는 올바른 동작

(대신에 볼 것)

## 관련 로그 및/또는 스크린샷

(관련 로그를 붙여넣으세요 - 콘솔 출력, 로그 및 코드를 서식화하기 위해 코드 블록 (```)을 사용하세요.
그렇지 않으면 읽기가 매우 어렵습니다.)

## 가능한 수정 사항

(가능하다면, 문제를 일으킬 수 있는 코드 라인에 링크를 제공하세요)

/label ~bug ~reproduced ~needs-investigation
/cc @project-manager
/assign @qa-tester