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

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

가끔은 브랜치에 몇 개의 커밋을 작성한 후에 하나 이상의 커밋 메시지를 업데이트해야 할 때가 있습니다. 어쩌면 오타를 발견했거나, 자동화 도구가 여러분의 커밋 메시지가 프로젝트의 커밋 메시지 가이드라인과 완전히 일치하지 않는다고 경고했을 수도 있습니다.

메시지를 업데이트하는 것은 명령 줄 인터페이스(CLI)에서 Git을 사용하는 데에 익숙하지 않은 경우에는 다소 어려울 수 있습니다. 하지만 걱정하지 마세요. GitLab UI에서 작업한 경험이 있는 경우에도 이 지침을 따라할 수 있습니다.

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

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

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

  1. 프로젝트 리포지터리를 로컬 머신에 복제.
  2. 로컬로 브랜치를 가져와서 확인아웃.
  3. 커밋 메시지 업데이트.
  4. 변경 사항을 GitLab에 푸시.

시작하기 전에

가지고 있어야 할 것:

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

마지막 단계에서 GitLab 계정으로 인증해야 합니다. GitLab 계정이 기본 사용자 이름과 암호 인증을 사용하는 경우, CLI에서 인증하려면 이중 요소 인증(2FA)을 비활성화해야 합니다. 또는 SSH 키를 사용하여 GitLab에 인증할 수 있습니다.

프로젝트 리포지터리를 로컬 머신에 복제

첫 번째 단계는 로컬 머신에서 리포지터리를 복제하는 것입니다:

  1. GitLab에서 프로젝트 개요 페이지에서 오른쪽 상단에 있는 Code를 선택합니다.
  2. 드롭다운 디렉터리에서 다음 중에서 본인의 리포지터리 URL을 복사합니다:
    • GitLab 계정이 기본 사용자 이름과 암호 인증을 사용하는 경우 옆의 Clone with HTTPS를 선택합니다.
    • GitLab 인증에 SSH를 사용하는 경우 옆의 Clone with SSH를 선택합니다.
  3. 이제 로컬 머신의 CLI(터미널, PowerShell 또는 비슷한)로 전환하여 리포지터리를 복제하려는 디렉터리로 이동합니다. 예: /users/my-username/my-projects/.

  4. git clone을 실행하고 이전에 복사한 URL을 붙여넣습니다. 예: 

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

    이 명령은 새 디렉터리인 my-awesome-project/에 리포지터리를 복제합니다.

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

로컬로 브랜치를 가져와서 확인아웃

이제 업데이트할 커밋이 포함된 브랜치로 확인아웃해야 합니다.

  1. 앞서 진행한 단계와 같은 위치에 있다고 가정하고 CLI에서 프로젝트 디렉터리로 이동합니다: 

    cd my-awesome-project

  2. 선택 사항. 리포지터리를 방금 복제했다면 브랜치가 이미 로컬에 있어야 합니다. 그러나 이전에 리포지터리를 이미 복제했고 이 단계로 건너뛴 경우, 다음 명령을 사용하여 브랜치를 가져와야 할 수도 있습니다: 

    git fetch origin my-branch-name

  3. 이제 브랜치가 로컬 시스템에 있는지 확인하고 해당 브랜치로 전환합니다: 

    git checkout my-branch-name

  4. git log를 사용하여 올바른 브랜치인지 확인하고 GitLab의 브랜치에 있는 커밋과 일치하는지 확인합니다. 로그를 종료하려면 q를 누릅니다.

커밋 메시지 업데이트

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

  1. GitLab에서 커밋 기록에서 업데이트해야 할 커밋의 이력을 확인합니다:

    • 이미 브랜치에 대한 Merge Request이 있으면 커밋 탭을 확인하여 커밋의 총 수를 찾을 수 있습니다.
    • 브랜치에서 작업 중인 경우:
      1. Code > 커밋으로 이동합니다.
      2. 왼쪽 상단에 있는 드롭다운 디렉터리을 선택하고 본인의 브랜치를 찾습니다.
      3. 업데이트하려는 가장 오래된 커밋을 찾아 그 커밋이 얼마나 이전에 있는지 세어봅니다. 예를 들어, 두 번째와 네 번째 커밋을 업데이트하려면 카운트는 4일 것입니다.

  2. CLI에서 이전 단계에서 얻은 커밋 수를 HEAD~ 뒤에 추가하여 대화식 리베이스를 시작합니다. 예시: 

    git rebase -i HEAD~4

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

  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에 알려줍니다. 업데이트하려는 커밋에 대해 명령을 pick에서 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가 있는 커밋에 도달하면 멈추고 다시 텍스트 에디터를 엽니다. 이제 커밋 메시지를 마침내 업데이트할 때입니다!

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

      월간 마일스톤 계획을 업데이트함

    • 커밋 메시지에 제목과 본문이 필요한 경우 이들을 공백으로 나누어 표시합니다. 예를 들어: 

      월간 마일스톤 계획을 업데이트함
     
각 유지 보수자의 책임을 나열하여 마일스톤 계획을 분명하게 만듦

    저장하고 나갔으면 Git은 커밋 메시지를 업데이트하고 순서대로 다음 커밋을 처리합니다. 완료되면 메시지 Successfully rebased and update refs/heads/my-branch-name가 표시됩니다.

  7. 선택 사항. 커밋 메시지가 업데이트되었는지 확인하려면 git log를 실행한 후 커밋 메시지를 확인할 수 있습니다.

변경 사항을 GitLab에 푸시하기

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

  1. CLI에서 변경 사항을 GitLab에 되돌려 푸시하십시오. GitLab의 이전 커밋을 덮어쓰는 “강제 푸시” 옵션 -f를 사용해야합니다. 

    git push -f origin

    GitLab의 커밋 메시지를 덮어쓰기 전에 터미널에서 사용자 이름과 암호를 입력해야 할 수 있습니다.

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

    • 이미 브랜치에 대한 Merge Request을 열어 둔 경우 커밋 탭을 확인하십시오.
    • 브랜치에서 작업 중인 경우:
      1. 코드 > 커밋으로 이동합니다.
      2. 왼쪽 상단의 드롭다운 디렉터리을 선택하여 브랜치를 찾습니다.
      3. 디렉터리에서 관련 커밋이 현재 업데이트되었는지 확인합니다.

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