.git-blame-ignore-revs는 버전 2.23에 도입된 Git 기능으로, git Blame 결과에서 특정 커밋을 무시할 수 있습니다. 이는 형식 변경, 이름 바꾸기 또는 코드베이스 전체에 코딩 표준 적용과 같은 코드의 실제 기능을 변경하지 않고 많은 수의 행을 변경하는 대량 커밋에 특히 유용합니다. 이러한 비기능적 변경 사항을 무시함으로써 git Blame은 코드 이면의 맥락과 추론을 설명하는 의미 있는 편집에 집중할 수 있습니다.

왜 .git-blame-ignore-revs가 중요한가요?

파일에 git Blame을 사용하면 작성자 및 타임스탬프와 함께 파일의 각 줄을 마지막으로 변경한 커밋이 표시됩니다. 이는 특정 행이 변경된 이유를 추적하는 데 유용합니다. 그러나 더 예쁘게 적용하는 등 순전히 형식 변경을 수행하는 대규모 커밋이 기록의 일부인 경우 git 비난은 여러 줄에서 해당 커밋을 가리킬 수 있습니다. 이로 인해 실제 기능 변경 내역을 찾기가 어렵습니다.

예를 들어 팀에서 Prettier 또는 ESLint와 같은 도구를 사용하여 전체 코드베이스의 형식을 다시 지정하는 경우 결과 커밋은 수천 줄의 코드에 포함될 수 있습니다. .git-blame-ignore-revs가 없으면 gitblame은 이 커밋이 영향을 받은 모든 줄에 책임이 있는 것으로 표시하여 각 줄 뒤에 있는 더 의미 있는 기록을 모호하게 할 수 있습니다.

.git-blame-ignore-revs를 사용하면 git Blame이 이러한 커밋을 건너뛰고 중요한 변경 사항에 집중하도록 지시할 수 있습니다.

사용 방법 .git-blame-ignore-revs

이 기능을 사용하는 방법을 이해하기 위해 React 저장소의 예를 살펴보겠습니다.

1단계: 대량 서식 지정 커밋 식별

React 소스 코드에는 Prettier와 같은 도구가 전체 프로젝트에서 실행되는 대량 커밋이 포함되어 있습니다. 다음은 두 가지 커밋입니다.

1. 커밋: c998bb1 메시지: [컴파일러] 더 예쁘게 실행하고 스냅 수정 이 커밋은 코드베이스 전체에 Prettier 형식을 적용하여 기능을 변경하지 않고 많은 줄을 변경합니다.

2. 커밋: fd2b3e1

메시지: 컴파일러: Unfork prettier config

이 커밋에는 Prettier 구성에 대한 추가 업데이트가 포함되어 저장소의 모든 .ts 및 .tsx 파일에 영향을 미칩니다.

이러한 커밋은 형식 지정만 처리하며 코드 줄이 원래대로 작성된 이유를 조사할 때 의미 있는 컨텍스트를 제공하지 않습니다.

2단계: .git-blame-ignore-revs 파일 생성

gitblame이 이러한 대량 서식 지정 커밋을 무시하도록 하려면 저장소 루트에 .git-blame-ignore-revs 파일을 만들 수 있습니다.

1. .git-blame-ignore-revs 파일을 생성합니다:

touch .git-blame-ignore-revs

2. 관련 커밋 해시를 파일에 추가하여 각 커밋이 무시되는 이유를 설명합니다. 이 경우 앞서 식별한 두 개의 커밋을 추가합니다.

# Prettier formatting changes 
c998bb1ed4b3285398c9c7797135d3f060243c6a 
fd2b3e13d330a4559f5aa21462e1cb2cbbcf144b

3. .git-blame-ignore-revs 파일을 저장소에 저장합니다. 이 파일은 코드와 함께 버전을 관리할 수 있으므로 전체 팀이 동일한 무시된 커밋 목록을 사용할 수 있습니다.

3단계: Git을 사용하도록 구성 .git-blame-ignore-revs

git Blame을 사용할 때마다 --ignore-revs-file 옵션을 입력하지 않으려면 Git이 자동으로 .git-blame-ignore-revs 파일을 사용하도록 구성할 수 있습니다.

1. 저장소 수준에서 구성을 설정합니다.

git config blame.ignoreRevsFile .git-blame-ignore-revs

이렇게 하면 누군가 이 저장소에서 git Blame을 실행할 때마다 Git이 .git-blame-ignore-revs에 나열된 커밋을 자동으로 무시합니다.

4단계: 실행 무시된 커밋으로 git 비난

이것이 실제로 어떻게 작동하는지 살펴보겠습니다. 대량 서식 지정 커밋을 무시하지 않으면 git Blame이 다음과 같이 표시될 수 있습니다.

$ git blame src/someFile.tsx
c998bb1e (Joe Bloggs 2023-03-15 10:00:00  0200 1) import React from 'react';
fd2b3e13 (Alan 2023-04-01 14:15:30  0200 2) function App() {
c998bb1e (Joe Bloggs 2023-03-15 10:00:00  0200 3)     return 
Hello, world!
;
fd2b3e13 (Ben 2023-04-01 14:15:30  0200 4) }

이 출력은 1행과 3행의 마지막 변경 사항이 Prettier 형식 지정 커밋(c998bb1e)으로 인한 것이며 2행과 4행이 다른 대량 커밋(fd2b3e13)에서 수정되었음을 나타냅니다. 이는 형식 변경이므로 누가 이 줄 뒤에 실제 논리를 도입했는지 이해하는 데 도움이 되지 않습니다.

.git-blame-ignore-revs를 구성한 후 git Blame을 실행하면 대량 커밋을 건너뛰고 실제 기록이 표시됩니다.

$ git blame src/someFile.tsx
a23d9b34 (May 2022-12-01 09:30:00  0200 1) import React from 'react';
b12e45a6 (JJ 2022-12-05 11:45:15  0200 2) function App() {
a23d9b34 (Joe 2022-12-01 09:30:00  0200 3)     return 
Hello, world!
;
b12e45a6 (Ram 2022-12-05 11:45:15  0200 4) }

이제 git Blame은 중요하지 않은 형식 변경을 무시하고 해당 행을 올바른 커밋에 귀속시킵니다. 이는 실제 기능 변경을 수행한 사람을 보여주는 유용한 정보를 제공합니다.

결론

Git 2.23의 .git-blame-ignore-revs 기능은 대량 서식 지정 또는 스타일 변경이 있는 프로젝트의 판도를 바꾸는 기능입니다. .git-blame-ignore-revs 파일을 설정하고 리포지토리를 구성하면 비난 기록 오염에 대한 걱정 없이 코딩 표준을 적용하고, Prettier와 같은 도구를 실행하거나 코드를 리팩터링할 수 있습니다.

이 접근 방식을 사용하면 팀은 의미 있는 변경 사항을 추적하는 기능을 희생하지 않고도 코드 품질과 형식을 자신있게 향상시킬 수 있으므로 git 비난이 각 코드 줄 뒤에 있는 기록과 추론을 이해하는 데 귀중한 도구로 남을 수 있습니다.

회사 소개:

Think Throo에서는 오픈 소스 프로젝트에 사용되는 고급 코드베이스 아키텍처 개념을 가르치는 임무를 수행하고 있습니다.

Next.js/React에서 고급 아키텍처 개념을 연습하여 코딩 기술을 10배 높이고, 모범 사례를 배우고, 프로덕션급 프로젝트를 구축하세요.

저희는 오픈 소스입니다 — https://github.com/thinkthroo/thinkthroo (별표를 주세요!)

코드베이스 아키텍처를 기반으로 한 고급 과정을 통해 팀의 기술을 향상하세요. 자세한 내용은 [email protected]으로 문의하세요!

참조:

1. https://github.com/facebook/react/blob/main/.git-blame-ignore-revs

2. https://gist.github.com/kateinoigakukun/b0bc920e587851bfffa98b9e279175f2

3. https://github.com/facebook/react/commit/c998bb1ed4b3285398c9c7797135d3f060243c6a

4. https://moxio.com/blog/ignoring-bulk-change-commits-with-git-blame/