튜토리얼: Git 커밋 메시지 업데이트

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

가끔은 브랜치에 몇 개의 커밋을 한 후에 한 개 이상의 커밋 메시지를 업데이트해야 할 때가 있습니다. 오타를 발견했거나 자동화된 경고로 커밋 메시지가 프로젝트의 커밋 메시지 가이드라인과 완전히 부합하지 않음을 알게 된 경우일 수도 있습니다.

메시지를 업데이트하는 것은 명령줄 인터페이스(CLI)에서 Git을 거의 사용해보지 않은 경우에는 약간 까다로울 수 있습니다. 하지만 걱정하지 마세요. GitLab UI에서 작업한 경험이 있는 경우에도 CLI를 사용하는 방법을 따라 할 수 있습니다.

이 튜토리얼에서는 다음 두 가지 경우에 대해 커밋 메시지를 다시 작성하는 방법을 설명합니다.

  • GitLab UI에서만 작업하는 경우, 1단계부터 시작합니다.
  • 이미 로컬로 저장소를 복제한 경우, 2단계로 건너뛸 수 있습니다.

여러 개의 커밋 메시지를 다시 작성하려면:

  1. 프로젝트 저장소를 로컬 머신에 복제합니다.
  2. 로컬에서 브랜치를 가져오고 이동합니다.
  3. 커밋 메시지를 업데이트합니다.
  4. 변경 사항을 GitLab에 푸시합니다.

시작하기 전에

다음이 필요합니다:

  • 업데이트할 커밋이 포함된 Git 브랜치를 가진 GitLab 프로젝트.
  • 로컬 머신에 Git이 설치되어 있어야 합니다.
  • 로컬 머신의 명령줄 인터페이스(CLI)에 액세스할 수 있어야 합니다. macOS의 경우 터미널, Windows의 경우 PowerShell을 사용할 수 있습니다. 리눅스 사용자는 기본 명령줄 인터페이스에 이미 익숙할 것입니다.
  • 시스템의 기본 편집기를 잘 알고 있어야 합니다. 이 튜토리얼은 기본적으로 Vim 편집기를 사용한다고 가정하지만 다른 텍스트 편집기도 작동합니다. Vim에 익숙하지 않은 경우 Vim 시작하기의 1단계에서 2단계까지 후에 사용되는 모든 명령에 대해 설명합니다.
  • 커밋 메시지를 덮어쓸 수 있는 권한이 있어야 합니다. 동일한 브랜치에서 여러 사람과 작업 중인 경우 먼저 그들과 함께 커밋을 업데이트해도 괜찮은지 확인해야 합니다. 일부 조직에서는 커밋을 다시 작성하는 것을 파괴적인 변경으로 여기기도 하므니다

마지막 단계에서 GitLab에 커밋 메시지를 덮어쓰려면 GitLab에 인증해야 합니다. GitLab 계정이 기본 사용자 이름 및 암호 인증을 사용하는 경우 CLI에서 인증을 받으려면 이중 인증 (2FA)를 비활성화해야 합니다. 또는 SSH 키를 사용하여 GitLab에 인증할 수 있습니다.

저장소를 로컬 머신에 복제합니다

첫 번째 단계는 로컬 머신에 저장소의 복제본을 얻는 것입니다:

  1. GitLab에서 프로젝트 개요 페이지에서 오른쪽 상단에 있는 Code를 선택합니다.
  2. 드롭다운 목록에서 저장소의 URL을 복사합니다. 기본 사용자 이름 및 암호 인증을 사용하는 경우 Clone with HTTPS 옆의 를 선택합니다. SSH를 사용하여 GitLab에 인증하는 경우 Clone with SSH를 선택합니다.
  3. 이제 로컬 머신의 CLI(터미널, PowerShell 또는 유사한 도구)로 전환하여 저장소를 복제할 디렉토리로 이동합니다. 예를 들어 /users/my-username/my-projects/와 같이 하면 됩니다.

  4. 다음을 실행하여 저장소를 복제합니다: 

    git clone https://gitlab.com/my-username/my-awesome-project.git

    이 명령은 새로운 디렉토리인 my-awesome-project/에 저장소를 복제합니다.

이제 저장소가 컴퓨터에 있어 Git CLI 명령을 사용할 준비가 되었습니다!

브랜치를 가져오고 이동합니다

다음으로 업데이트할 커밋이 포함된 브랜치로 이동해야 합니다.

  1. 이전 단계와 같은 위치에 있는 것으로 가정하고 CLI로 프로젝트 디렉토리로 이동합니다. cd 명령을 사용하세요: 

    cd my-awesome-project

  2. 선택 사항입니다. 방금 저장소를 복제했다면 이미 브랜치가 로컬에 있어야 합니다. 그러나 이전에 저장소를 복제하고 이 단계로 건너뛴 경우 브랜치를 가져와야 할 수도 있습니다: 

    git fetch origin my-branch-name

  3. 브랜치가 로컬 시스템에 있는지 확인하고 다음으로 그 브랜치로 이동합니다: 

    git checkout my-branch-name

  4. git log 명령을 사용하여 올바른 브랜치인지 확인하고 GitLab의 브랜치에 있는 커밋과 일치하는지 확인하세요. 로그를 빠져나오려면 q를 사용합니다.

커밋 메시지를 업데이트합니다

이제 커밋 메시지를 업데이트할 준비가 되었습니다:

  1. GitLab에서 커밋 히스토리에서 얼마나 이전의 지점까지 갈 필요가 있는지 확인합니다.

    • 이미 브랜치에 대한 병합 요청을 열어 놓은 경우 커밋 탭을 확인하고 커밋의 총 수를 사용할 수 있습니다.
    • 브랜치에서 작업 중인 경우:
      1. Code > Commits로 이동합니다.
      2. 왼쪽 상단의 드롭다운 목록을 선택하고 여러분의 브랜치를 찾습니다.
      3. 업데이트를 원하는 가장 오래된 커밋을 찾아 거기까지 얼마나 뒤로 가는지 세어봅니다. 예를 들어, 두 번째와 네 번째 커밋을 업데이트하려면 카운트는 4여야 합니다.

  2. CLI에서 시작하려면 커밋을 업데이트하는 Git 프로세스인 대화식 리베이스를 시작합니다. 앞 단계에서 센 커밋의 수를 HEAD~ 뒤에 추가하세요. 예를 들어: 

    git rebase -i HEAD~4

    이 예에서 Git은 브랜치의 네 개의 가장 최근 커밋을 선택합니다.

  3. Git은 텍스트 편집기를 열고 선택한 커밋을 나열합니다. 예를 들어 다음과 같이 보일 것입니다: 

    pick a0cea50 Fix broken link
pick bb84712 Update milestone-plan.md
pick ce11fad Add list of maintainers
pick d211d03 update template.md

# Rebase 1f5ec88..d211d03 onto 1f5ec88 (4 commands)
#
# Commands:
# p, pick <commit> = use commit
# r, reword <commit> = use commit, but edit the commit message
# e, edit <commit> = use commit, but stop for amending
# s, squash <commit> = use commit, but meld into previous commit
# f, fixup [-C | -c] <commit> = like "squash" but keep only the previous
#                    commit's log message, unless -C is used, in which case
# [and so on...]

  4. pick 명령은 커밋을 변경하지 않고 사용하도록 Git에 알립니다. 업데이트를 원하는 커밋에 대해 명령을 reword로 변경해야 합니다. i를 입력하여 INSERT 모드로 들어가고 텍스트를 편집하세요.

    예를 들어 위의 샘플에서 두 번째와 네 번째 커밋의 텍스트를 업데이트하려면 다음과 같이 편집합니다: 

    pick a0cea50 Fix broken link
reword bb84712 Update milestone-plan.md
pick ce11fad Add list of maintainers
reword d211d03 update template.md

  5. 편집된 텍스트를 저장합니다. INSERT 모드를 빠져나오려면 Escape를 누르고 :wq를 입력한 후 Enter를 누릅니다.

  6. 이제 Git은 각 커밋을 한 번씩 돌면서 선택한 명령을 적용합니다. pick이 있는 커밋은 변경되지 않은 채로 브랜치에 다시 추가됩니다. Git이 reword라는 커밋에 도달하면 중지되고 다시 텍스트 편집기가 열립니다. 이제 커밋 메시지를 최종적으로 업데이트할 시간입니다!

    • 한 줄짜리 커밋 메시지만 필요한 경우 필요한 대로 텍스트를 업데이트하세요. 예를 들어: 

      Update the monthly milestone plan

    • 커밋 메시지가 제목과 본문이 필요한 경우 이들을 빈 줄로 구분하세요. 예를 들어: 

      Update the monthly milestone plan

Make the milestone plan clearer by listing the responsibilities
of each maintainer.

    저장하고 나오면 Git이 커밋 메시지를 업데이트하고 순서대로 다음 커밋을 처리합니다. 작업이 끝나면 메시지 ‘Successfully rebased and update refs/heads/my-branch-name’가 표시됩니다.

  7. 선택 사항입니다. 커밋 메시지가 업데이트되었는지 확인하려면 git log를 실행하여 커밋 메시지를 아래로 스크롤하여 확인할 수 있습니다.

변경 사항을 GitLab에 푸시하세요

이제 남은 일은 이러한 변경 사항을 GitLab에 푸시하는 것뿐입니다:

  1. CLI에서 변경 사항을 다시 GitLab에 푸시합니다. “강제 푸시” 옵션 -f를 사용해야 합니다. 이는 커밋이 업데이트되었고 강제로 이전 커밋을 덮어쓰기 때문입니다. 

    git push -f origin

    터미널에서 이전 커밋 메시지를 덮어쓰기 전에 사용자 이름과 암호를 입력하라는 메시지가 표시될 수 있습니다.

  2. GitLab 프로젝트에서 커밋이 업데이트되었는지 확인하세요:

    • 이미 브랜치에 대한 병합 요청을 열어 둔 경우 커밋 탭을 확인합니다.
    • 브랜치에서 작업 중인 경우:
      1. 코드 > 커밋으로 이동합니다.
      2. 왼쪽 상단의 드롭다운 목록을 선택하고 브랜치를 찾습니다.
      3. 목록에서 해당하는 커밋이 이제 업데이트되었는지 확인합니다.

축하합니다! 커밋 메시지를 성공적으로 업데이트하고 GitLab에 푸시했습니다!