이 글의 핵심 주제를 한눈에 설명하는 이미지입니다: .gitignore 파일을 사용하여 Git 추적에서 파일 제외하는 방법

.gitignore란?

.gitignore 파일은 Git에게 프로젝트에서 어떤 파일이나 폴더를 무시할지 알려주는 텍스트 파일입니다. 무시된 파일은 Git에 의해 추적되지 않으므로 스테이징되거나 커밋되지 않습니다. 이는 로그 파일, 컴파일된 코드 또는 node_modules와 같은 의존성 폴더와 같이 컴퓨터나 빌드 프로세스에 의해 생성되는 파일에 유용합니다.

문제 상황

git status를 실행하면 커밋하고 싶지 않은 추적되지 않은 파일의 긴 목록이 표시됩니다. 이들은 시스템 파일, 편집기 구성 파일 또는 빌드 아티팩트일 수 있습니다.

git status
On branch main
Untracked files:
  (use "git add <file>..." to include in what will be committed)
        .DS_Store
        logs/debug.log
        build/
        node_modules/

이러한 파일을 커밋하면 저장소가 불필요하게 부풀려지고 다른 협업자에게 문제를 일으킬 수 있습니다.

해결 방법

1. .gitignore 파일 생성하기

Git 저장소의 루트 디렉터리에 .gitignore라는 이름의 파일을 만듭니다.

텍스트 편집기나 명령줄 도구를 사용하여 만들 수 있습니다.

touch .gitignore

2. .gitignore에 패턴 추가하기

.gitignore 파일을 열고 무시하려는 파일 및 디렉터리에 대한 패턴을 추가합니다. 각 패턴은 새 줄에 있어야 합니다.

# macOS 시스템 파일 무시
.DS_Store

# 로그 파일 무시
logs/
*.log

# 빌드 출력 디렉터리 무시
build/

# 의존성 디렉터리 무시
node_modules/
  • #: 해시로 시작하는 줄은 주석입니다.
  • logs/: 전체 logs 디렉터리를 무시합니다.
  • *.log: .log 확장자를 가진 모든 파일(예: debug.log, error.log)을 무시합니다.
  • build/: build 디렉터리를 무시합니다.
  • node_modules/: node_modules 디렉터리를 무시합니다.

3. .gitignore 파일 커밋하기

.gitignore 파일 자체는 저장소에 커밋해야 합니다. 이렇게 하면 모든 협업자에게 동일한 무시 규칙이 적용됩니다.

git add .gitignore
git commit -m "Add .gitignore file"

이제 git status를 실행하면 무시된 파일이 더 이상 추적되지 않은 파일 목록에 나타나지 않습니다.

이미 추적된 파일 무시하기

실수로 무시해야 할 파일을 커밋했다면 어떻게 해야 할까요? 단순히 .gitignore에 파일을 추가하는 것만으로는 Git이 추적을 멈추지 않습니다.

먼저 git rm --cached를 사용하여 Git에게 파일 추적을 중지하도록 알려야 합니다.

예를 들어, config.local 파일 추적을 중지하려면:

  1. .gitignore 파일에 config.local을 추가합니다.
  2. 다음 명령을 실행합니다. 
    git rm --cached config.local
  3. 변경 사항을 커밋합니다. 
    git commit -m "Stop tracking config.local"

--cached 옵션은 Git의 추적에서 파일을 제거하지만 로컬 디렉터리에는 그대로 유지됩니다.

전역 .gitignore

시스템의 모든 저장소에 대한 전역 .gitignore 파일을 만들 수도 있습니다. 이는 운영 체제나 편집기 관련 파일을 무시하는 데 유용합니다.

  1. 예를 들어 ~/.gitignore_global 파일을 만듭니다.
  2. Git이 이 파일을 사용하도록 구성합니다. 
    git config --global core.excludesfile ~/.gitignore_global
  3. 이 파일에 전역 패턴을 추가합니다.

결론

.gitignore 파일을 사용하는 것은 저장소를 깨끗하게 유지하고 중요한 소스 코드에 집중하는 데 필수적입니다. 불필요한 파일이 커밋되고 공유되는 것을 방지합니다. 다양한 프로그래밍 언어 및 프레임워크에 대한 많은 템플릿이 온라인에서 제공되므로 시작하는 데 도움이 될 수 있습니다.

전문 보완 체크

.gitignore 파일을 사용하여 Git 추적에서 파일 제외하는 방법에서 중요한 기준은 독자가 한 번 따라 해서 성공했는지가 아닙니다. 이 주제는 재현 가능한 디버깅 절차로 다루는 편이 안전합니다. 결론을 내리기 전에 저장소 루트, 브랜치와 원격 상태, 인덱스와 작업 트리, 인증 또는 네트워크 경계를 확인해야 합니다. 또한 나중에 같은 문제가 반복될 수 있으므로, 관찰한 사실과 사용한 가정, 결론이 바뀔 조건을 짧은 결정 기록으로 남기는 것이 좋습니다.

신뢰도를 높이는 증거

작업을 바꾸기 전에는 객관적인 증거를 먼저 확인해야 합니다. 쓸 만한 증거에는 git status, git remote -v, git branch --show-current, 실패한 정확한 명령가 포함됩니다. 증거가 서로 맞지 않으면 억지로 하나의 이야기로 합치지 말고 충돌 자체를 남겨야 합니다. 빠른 해결이 한 번 성공했더라도 같은 입력, 계정, 의존성, 기기 상태에서 다시 확인하지 않았다면 아직 확정된 해결책이라고 보기 어렵습니다.

검토 표

검토 항목 확인할 내용 중요한 이유
범위 이 글이 다루는 정확한 사례 조언을 과도하게 적용하지 않게 합니다
기준 상태 변경 전 상태 되돌리기와 비교를 가능하게 합니다
변경 실제로 수행한 가장 작은 조치 숨은 부작용을 줄입니다
결과 변경 뒤 관찰한 출력 또는 반응 기대와 증거를 구분합니다
재확인 결론을 다시 볼 시점 글의 정확도를 유지합니다

예외 상황과 실패 모드

주요 위험은 증상만 고치고 원인을 남기는 상황, 서로 무관한 변경을 같은 테스트에 섞는 상황입니다. 생산 데이터, 개인정보, 돈, 건강, 법적 권리, 보안 복구가 관련되어 있다면 넓은 해결책을 바로 적용하기보다 먼저 증거를 모으는 보수적인 접근이 낫습니다. 같은 제목의 문제라도 환경이 다르면 원인이 달라질 수 있으므로, 독자는 명령이나 결정을 복사하기 전에 자신의 조건이 글의 가정과 맞는지 비교해야 합니다.

유지보수 기준

이 안내는 의존성, 운영체제, 빌드 도구가 바뀐 뒤 다시 확인해야 합니다. 좋은 업데이트는 글 전체를 다시 쓰는 것이 아니라 예시, 링크, 명령, 화면, 판단 기준이 현재 동작과 여전히 맞는지 확인하는 일입니다. 기존 결론이 유효하면 확인 날짜를 남기고, 바뀌었다면 무엇이 바뀌었고 왜 이전 조언만으로 부족한지 설명해야 합니다.

실행 전 질문

  • 문제나 판단이 실제임을 보여 주는 가장 작은 관찰 신호는 무엇인가?
  • 공식 출처는 무엇이고, 내부 판단은 어느 부분인가?
  • 변경 전에 반드시 캡처해야 할 기록은 무엇인가?
  • 어떤 결과가 나오면 이 글의 조언이 맞지 않는다고 볼 것인가?
  • 같은 문제가 반복될 때 누가 이 기록을 다시 봐야 하는가?

적용 검토 시나리오

독자가 .gitignore 파일을 사용하여 Git 추적에서 파일 제외하는 방법의 첫 번째 권장 조치를 이미 시도했지만 결과가 여전히 불확실하다고 가정해 봅니다. 다음 단계는 여러 해결책을 한꺼번에 시험하는 것이 아니라 짧은 감사 기록을 만드는 것입니다. 먼저 어떤 판단을 하려는지 한 문장으로 쓰고, 환경을 한 문장으로 적고, 관찰된 결과를 한 문장으로 남깁니다. 그다음 저장소 루트, 브랜치와 원격 상태, 인덱스와 작업 트리, 인증 또는 네트워크 경계를 이미 확보한 사실과 대조합니다. 이렇게 해야 글이 서로 끊어진 팁 목록이 아니라 검증 가능한 절차가 됩니다.

감사 기록 양식

항목 예시 기준 이유
관찰 조치 전 실제로 본 내용 기준 상태를 객관화합니다
증거 git status, git remote -v 판단을 기록에 연결합니다
가정 믿고 있지만 아직 증명하지 못한 내용 숨은 추정을 드러냅니다
조치 한 번에 하나의 변경 결과의 원인을 추적하게 합니다
중단 기준 멈추고 도움을 요청할 조건 반복적인 시행착오를 줄입니다

품질 경계

같은 결과가 통제된 재확인 뒤에도 반복될 때만 이 안내를 강한 결론으로 보아야 합니다. 계정, 기기, 데이터 샘플, 의존성 버전, 계약 조건, 공식 규칙이 달라졌다면 결론의 강도를 낮추고 가설로 다루는 편이 안전합니다. 검색 독자는 급한 문제를 안고 들어오는 경우가 많아 맥락을 건너뛰기 쉽습니다. 전문적인 글은 위험한 판단을 천천히 하게 만들면서도 다음 행동은 분명하게 제시해야 합니다.

함께 보면 좋은 글

같은 주제 흐름에서 이어서 읽기 좋은 글입니다.

Leave a comment

You may also enjoy