설명 템플릿

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

Issues병합 요청에 사용할 템플릿을 정의할 수 있습니다.

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

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

  • 워크플로우의 다양한 단계에 대해, 예를 들어, 기능 제안, 기능 개선 또는 버그 보고서.
  • 특정 프로젝트의 각 문제 또는 병합 요청에 대해 레이아웃이 일관되도록합니다.
  • Service Desk 이메일 템플릿을 위해.

설명 템플릿을 사용하려면 다음이 되어야 합니다:

  • .md 확장자로 저장되어야 합니다.
  • 프로젝트의 저장소 내부의 .gitlab/issue_templates 또는 .gitlab/merge_request_templates 디렉터리에 저장되어야 합니다.
  • 기본 브랜치에 있어야 합니다.

이슈 템플릿 만들기

저장소의 .gitlab/issue_templates/ 디렉터리 내부에 새로운 Markdown(.md) 파일을 만듭니다.

이슈 설명 템플릿을 만들려면:

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

이것이 올바르게 작동하는지 확인하려면 새 이슈를 만들고 템플릿 선택 드롭다운 목록에서 설명 템플릿을 찾을 수 있는지 확인합니다.

병합 요청 템플릿 만들기

이슈 템플릿과 비슷하게, 저장소 내부의 .gitlab/merge_request_templates/ 디렉토리에 새로운 Markdown(.md) 파일을 만듭니다. 하지만 이슈 템플릿과는 달리 병합 요청에는 추가 상속 규칙이 있으며 이는 커밋 메시지와 브랜치 이름에 따라 다릅니다.

프로젝트의 병합 요청 설명 템플릿을 만들려면:

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

이것이 올바르게 작동하는지 확인하려면 새 병합 요청을 만들고 템플릿 선택 드롭다운 목록에서 설명 템플릿을 찾을 수 있는지 확인합니다.

템플릿 사용하기

이슈 또는 병합 요청을 만들거나 편집할 때 템플릿 선택 드롭다운 목록에 표시됩니다.

템플릿을 적용하려면:

  1. 이슈 또는 병합 요청을 생성하거나 편집합니다.
  2. 템플릿 선택 드롭다운 목록을 선택합니다.
  3. Description 텍스트 상자가 비어 있지 않다면 템플릿 적용을 선택하여 확인합니다.
  4. 변경 사항 저장을 선택합니다.

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

템플릿을 선택한 후, 템플릿을 선택한 후에 설명에 대한 변경 내용을 모두 취소하려면 템플릿 선택 드롭다운 목록을 확장하고 템플릿 재설정을 선택합니다.

이슈에서 설명 템플릿 선택

note
지정된 템플릿을 사용하여 이슈를 만들 수 있는 바로 가기 링크를 만들 수 있습니다. 예시: https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Feature%20proposal. 미리 채워진 값 사용하여 URL을 통해 문제 만들기에 대해 자세히 알아보세요.

병합 요청 템플릿에서 지원되는 변수

note
이 기능은 기본 템플릿에만 사용할 수 있습니다.

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

변수 설명 출력 예시
%{all_commits} 병합 요청에서 모든 커밋의 메시지입니다. 가장 최근 100개의 커밋에 제한됩니다. 100KiB를 초과하는 커밋 본문 및 병합 커밋 메시지는 건너뜁니다. * 기능 도입됨

이 커밋은 기능을 구현합니다
변경 내용: 추가됨

* 버그 수정됨

* 문서가 향상되었습니다

이 커밋은 더 나은 문서를 소개했습니다.
%{co_authored_by} 병합 요청의 가장 최근 100개의 커밋 저자의 이름과 이메일을 Co-authored-by Git 커밋 트레일러 형식으로 제한합니다. Co-authored-by: Zane Doe <zdoe@example.com>
Co-authored-by: Blake Smith <bsmith@example.com>
%{first_commit} 병합 요청 차이에서 첫 번째 커밋의 전체 메시지입니다. README.md 수정
%{first_multiline_commit} 병합 요청 제목이 모든 커밋이 여러 줄로 구성되지 않은 병합 커밋이 아닌 경우 첫 번째 커밋의 전체 메시지입니다. 모든 커밋이 여러 줄로 구성되지 않았다면 병합 요청 제목입니다. README.md 수정

README 파일에서 프로젝트 설명이 향상되었습니다.
%{source_branch} 병합 중인 브랜치의 이름입니다. 내-기능-브랜치
%{target_branch} 변경 사항이 적용되는 브랜치의 이름입니다. main

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

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

이슈와 병합 요청에 대한 인스턴스 수준 설명 템플릿을 인스턴스 템플릿 저장소를 사용하여 설정할 수 있습니다. 또한, 인스턴스 템플릿 저장소를 파일 템플릿에도 사용할 수 있습니다.

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

그룹 수준 설명 템플릿 설정

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

그룹 수준 설명 템플릿을 사용하여 그룹 내의 프로젝트를 선택하여 템플릿을 저장할 수 있습니다. 그런 다음 해당 템플릿을 그룹의 모든 프로젝트에서 액세스할 수 있습니다. 따라서 해당 그룹의 모든 프로젝트에서 설명 및 병합 요청에 동일한 템플릿을 사용할 수 있습니다.

전제 조건:

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

생성한 템플릿을 재사용하려면 여기에서:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 그룹을 찾습니다.
  2. 설정 > 일반을 선택합니다.
  3. 템플릿을 확장합니다.
  4. 드롭다운 목록에서 템플릿 저장소로서 템플릿 프로젝트를 선택합니다.
  5. 변경 사항 저장을 선택합니다.

그룹 템플릿 설정

또한, 해당 그룹의 다양한 파일 유형에 대한 템플릿에도 관심이 있을 수 있습니다.

병합 요청 및 이슈에 대한 기본 템플릿 설정

  • GitLab 14.8에서 소개된 Default.md (대소문자 무관) 템플릿.

프로젝트에서 새 이슈와 병합 요청에 대한 기본 설명 템플릿을 선택할 수 있습니다. 결과적으로, 새 병합 요청이나 이슈를 생성할 때마다 해당 템플릿에 입력한 텍스트가 미리 채워집니다.

전제 조건:

  • 프로젝트의 왼쪽 사이드바에서 설정 > 일반을 선택하고 가시성, 프로젝트 기능, 권한을 확장합니다. 이슈 또는 병합 요청이 모든 접근 권한 있는 사람 또는 프로젝트 멤버만으로 설정되어 있는지 확인합니다.

병합 요청에 대한 기본 설명 템플릿을 설정하려면 다음 중 하나:

  • GitLab 14.8 및 이후에서 Default.md (대소문자 무관) 템플릿을 .gitlab/merge_request_templates/에 저장하여 병합 요청 템플릿을 생성합니다. 이로 인해, 프로젝트 설정에서 기본 템플릿이 이미 설정되어 있다면 덮어쓰지 않습니다.
  • GitLab Premium 및 Ultimate 사용자: 프로젝트 설정에서 기본 템플릿을 설정합니다.

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

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

  • GitLab 14.8 및 이후에서 Default.md (대소문자 무관) 템플릿을 .gitlab/issue_templates/에 저장하여 이슈 템플릿을 생성합니다. 이로 인해, 프로젝트 설정에서 기본 템플릿이 이미 설정되어 있다면 덮어쓰지 않습니다.
  • GitLab Premium 및 Ultimate 사용자: 프로젝트 설정에서 기본 템플릿을 설정합니다.

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

GitLab 병합 요청과 이슈는 Markdown을 지원하므로 제목, 목록 등을 포맷팅하는 데 사용할 수 있습니다.

또한, 기본 이슈와 병합 요청 템플릿을 최신 상태로 유지하기 위해 프로젝트 REST API에서 issues_templatemerge_requests_template 속성을 제공할 수도 있습니다.

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

여러 위치에서 이슈 설명 템플릿을 설정할 때, 해당 프로젝트에서 다음과 같은 우선 순위가 있습니다. 아래에 있는 것들이 위에 있는 것들을 덮어쓰게 됩니다:

  1. 프로젝트 설정에 설정된 템플릿.
  2. 상위 그룹의 Default.md (대소문자 무관).
  3. 프로젝트 저장소의 Default.md (대소문자 무관).

병합 요청에는 추가 상속 규칙이 있으며, 이는 커밋 메시지 및 브랜치 이름의 내용에 따라 달라집니다.

요약

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

재현 방법

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

예시 프로젝트

(가능하다면, 문제가 발생하는 예시 프로젝트를 GitLab.com에서 생성하고, 버그 보고서에 링크를 걸어주세요. GitLab의 이전 버전을 사용 중이라면, 이를 통해 해당 버그가 최근 버전에서 수정되었는지 확인할 수 있습니다.)

현재 버그 동작

(실제로 발생한 일)

기대하는 정상적인 동작

(대신 볼 것)

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

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

가능한 수정 사항

(가능하다면, 문제의 원인이 될 수 있는 코드 라인에 링크를 추가해주세요)

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