변경 제안

Tier: Free, Premium, Ultimate Offering: GitLab.com, 자체 관리, GitLab 전용

리뷰어는 병합 요청 diff 스레드에서 Markdown 구문을 사용하여 코드 변경을 제안할 수 있습니다. 병합 요청 작성자(또는 적절한 역할을 가진 다른 사용자)는 GitLab UI에서 제안 중 하나 또는 모든 제안을 적용할 수 있습니다. 제안을 적용하면 변경 사항을 제안한 사용자가 작성한 커밋이 병합 요청에 추가됩니다.

제안 생성

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 코드 > 병합 요청을 선택하고 병합 요청을 찾습니다.
  3. 보조 메뉴에서 변경을 선택합니다.
  4. 변경하려는 코드 행을 찾습니다.
    • 단일 행을 선택하려면 행 번호 위로 마우스를 올리고 이 행에 댓글 추가를 선택합니다().
    • 여러 줄을 선택하려면:
      1. 행 번호 위로 마우스를 올리고 이 행에 댓글 추가를 선택합니다(): 다른 diff 파일 행에 댓글 달기
      2. 원하는 모든 행을 포함하도록 선택하고 끌어 옵니다. 자세한 내용은 다중 행 제안을 참조하세요.
  5. 댓글 툴바에서 제안 삽입()을 선택합니다. GitLab은 다음과 같이 미리 작성된 코드 블록을 댓글에 삽입합니다.

    ```suggestion:-0+0
    선택한 행의 내용이 여기에 표시됩니다.
    ```
    
  6. 미리 작성된 코드 블록을 편집하여 제안을 추가합니다.
  7. 즉시 댓글을 추가하려면 지금 댓글 추가를 선택하거나 키보드 단축키를 사용합니다.
    • macOS: Shift + Command + Enter
    • 다른 OS: Shift + Control + Enter
  8. 리뷰를 완료할 때까지 댓글을 게시하지 않으려면 리뷰 시작을 선택하거나 키보드 단축키를 사용합니다.
    • macOS: Command + Enter
    • 다른 OS: Control + Enter

다중 행 제안

병합 요청 diff를 검토할 때 다음을 수행하여 단일 제안에서 최대 200줄까지의 여러 줄에 대한 변경을 제안할 수 있습니다.

  • 제안 생성에서 설명한대로 선택하고 끌어 옵니다. GitLab은 대신 제안 블록을 생성합니다.
  • 단일 행을 선택한 다음 제안 블록에서 범위 오프셋을 수동으로 수정합니다.

제안의 첫 번째 라인에 있는 범위 오프셋은 선택한 행을 기준으로한 줄 번호를 설명합니다. 오프셋은 제안이 교체할 의도인 행을 지정합니다. 예를 들어, 이 제안은 주석이 달린 행 위아래로 2줄씩 총 2줄을 포함합니다.

```suggestion:-2+2
## 작성자에 의한 승인 방지

기본적으로 병합 요청 작성자는 승인할 수 없습니다. 이 설정을 변경하려면:
```

적용되면 제안은 주석이 달린 줄 위에서부터 아래로 2줄을 대체합니다.

다중 행 제안 미리보기

다중 행에 대한 제안은 주석 diff 행의 위쪽으로 최대 100줄, 아래쪽으로 최대 100줄로 제한됩니다.

여러 줄을 위한 제안은 제안 당 최대 201줄의 변경을 가능하게 합니다.

여러 줄 댓글은 댓글 내용 위에 댓글의 행 번호를 표시합니다:

여러 줄 댓글 선택이 댓글 위에 표시됨

리치 텍스트 편집기 사용

  • GitLab 16.1에서 도입content_editor_on_issues라는 플래그로 제공됩니다. 기본적으로 비활성화됨.
  • GitLab 16.2에서 GitLab.com 및 자체 관리에서 활성화됩니다.
  • 플래그 content_editor_on_issues가 GitLab 16.5에서 제거되었습니다.

제안을 삽입할 때 UI에서 소스 파일의 행 번호를 위아래로 이동하는 데 WYSIWYG 리치 텍스트 편집기를 사용할 수 있습니다.

변경된 줄을 추가하거나 제거하려면 이 위치부터 옆에 + 또는 -을 선택합니다.

다중 행 제안 미리보기

제안 적용

전제 조건:

  • 병합 요청의 작성자이거나 프로젝트의 최소한 Developer 역할을 가지고 있어야 합니다.

병합 요청에서 제안된 변경 사항을 직접 적용하려면:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 코드 > 병합 요청을 선택하고 병합 요청을 찾습니다.
  3. 적용하려는 제안이 포함된 댓글을 찾습니다.
    • 개별적으로 제안을 적용하려면 제안 적용을 선택합니다.
    • 여러 제안을 하나의 커밋으로 적용하려면 일괄 제안에 추가를 선택합니다.
  4. 원하는 경우 변경 사항을 설명하는 사용자 정의 커밋 메시지를 제공합니다. 사용자 정의 메시지를 제공하지 않으면 기본 커밋 메시지가 사용됩니다.
  5. 적용을 선택합니다.

제안을 적용한 후 GitLab은 다음을 수행합니다:

  • 제안을 적용됨으로 표시합니다.
  • 댓글 스레드를 해결합니다.
  • 변경 내용이 있는 새 커밋을 생성합니다.
  • (사용자가 Developer 역할을 가지고 있으면) 제안된 변경을 병합 요청 브랜치의 코드베이스로 직접 푸시합니다.

제안에 코드 블록 중첩

fenced code block을 포함하는 제안을 추가하려면 세 개가 아닌 네 개의 역따옴표로 제안을 감쌉니다:

````suggestion:-0+2
```shell
git config --global receive.advertisepushoptions true
```

fenced code block가 포함된 제안이 있는 댓글의 출력

적용된 제안의 커밋 메시지 구성

GitLab은 제안을 적용할 때 기본 커밋 메시지를 사용하지만 수정할 수 있습니다. 이 메시지는 플레이스홀더를 지원합니다. 예를 들어, 세 가지 제안을 두 가지 다른 파일로 적용하는 경우 기본 메시지 Apply %{suggestions_count} suggestion(s) to %{files_count} file(s)는 다음과 같이 렌더링됩니다.

3개의 제안을 2개의 파일에 적용함

포크에서 생성된 병합 요청은 대상 프로젝트에 정의된 템플릿을 사용합니다. 프로젝트의 요구 사항을 충족시키려면 이러한 메시지를 수정하고 다른 플레이스홀더 변수를 포함시킵니다.

전제 조건:

  • Maintainer 역할을 가져야 합니다.

다음과 같이 수행합니다:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
  2. 설정 > 병합 요청을 선택합니다.
  3. 제안 병합으로 스크롤하여 요구 사항에 맞도록 텍스트를 수정합니다. 지원되는 변수 목록을 보려면 지원되는 변수를 참조하세요.

지원되는 변수

적용된 제안에 대한 커밋 메시지 템플릿은 다음 변수를 지원합니다.

변수 설명 출력 예시
%{branch_name} 제안이 적용된 브랜치의 이름입니다. my-feature-branch
%{files_count} 제안이 적용된 파일의 수입니다. 2
%{file_paths} 제안이 적용된 파일의 경로입니다. 경로는 쉼표로 구분됩니다. docs/index.md, docs/about.md
%{project_path} 프로젝트 경로입니다. my-group/my-project
%{project_name} 프로젝트의 사람이 읽을 수 있는 이름입니다. My Project
%{suggestions_count} 적용된 제안의 수입니다. 3
%{username} 제안을 적용하는 사용자의 사용자 이름입니다. user_1
%{user_full_name} 제안을 적용하는 사용자의 전체 이름입니다. User 1
%{co_authored_by} Co-authored-by Git 커밋 트레일러 형식의 제안 작성자의 이름과 이메일입니다. Co-authored-by: Zane Doe <zdoe@example.com>
Co-authored-by: Blake Smith <bsmith@example.com>

예를 들어, 커밋 메시지를 user_1의 리뷰에 대한 주소로 사용자 정의하려면 사용자 정의 텍스트를 Addresses %{username}'s review로 설정하세요.

일괄 제안

필수 조건:

  • 소스 브랜치에 커밋할 수 있는 프로젝트 역할이 있어야 합니다.

브랜치에 추가된 커밋 수를 줄이려면 여러 제안을 하나의 커밋에 적용합니다.

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하여 프로젝트를 찾습니다.
  2. 코드 > 병합 요청를 선택하여 병합 요청을 찾습니다.
  3. 적용하려는 각 제안에 대해 일괄 제안에 추가를 선택합니다.
  4. 선택 사항. 제안을 제거하려면 일괄에서 제거를 선택합니다.
  5. 원하는 제안을 추가한 후 제안 적용을 선택합니다.

    경고: 여러 제안이 포함된 일괄 제안을 적용하면 결과적인 커밋은 여러 작성자의 변경 사항을 포함하고 작성자로서 당신을 표시합니다. 만약 프로젝트를 구성하여 커밋을 추가하는 사용자의 승인을 방지하도록 했다면, 해당 병합 요청에 대한 승인자 자격이 없어집니다.

  6. 선택 사항. 일괄 제안에 대한 사용자 정의 커밋 메시지를 제공하여 변경 내용을 설명합니다. 지정하지 않으면 기본 커밋 메시지가 사용됩니다.

관련 주제