• Knowledge

Git에 올리면 안 되는 파일, .gitignore로 관리하기

빌드 산출물, 의존성, 환경 설정 등 Git에서 제외할 파일과 .gitignore 패턴 작성법을 예제로 살펴봅니다.

시리즈15편 중 7편Git 기초와 활용
  1. 01분산형 버전관리 시스템(Distributed Version Control System)이란?
  2. 02Git(깃)의 등장
  3. 03Git 의 장점 (왜 빠른건가요?)
  4. 04Git의 저장소 구조 및 워크플로우
  5. 05Git 시작하기 - 초기화 및 설정
  6. 06Git에서 autocrlf는 왜 설정해야 할까?
  7. 07Git에 올리면 안 되는 파일, .gitignore로 관리하기읽는 중
  8. 08git tag 활용방법
  9. 09Semantic Version 관리 (v1.0.0-rc.1)
  10. 10Commit Message Convention (feat: 로그인 기능 추가)
  11. 11git commit template - 그래서 commit convention 을 어떻게 외우지?
  12. 12Branch 사용 방법 (브랜치를 꼭 써야하나요?)
  13. 13git merge 어떻게 하면 될까? (merge 경우의 수)
  14. 14(중요) git rebase -i 로 깔끔하게 커밋 정리
  15. 15git stash - 커밋하기엔 애매할 때 잠시 보관

git 으로 파일을 관리할 때, 일반적으로 제외시키는 파일들이 있다.

Git 에 올리면 안되는 파일 종류

대표적인 것들을 소개한다.

  1. 빌드 산출물 및 컴파일 된 파일(ex. build/, dist/, *., *.exe)
    • 빌드나 컴파일 과정에서 생성되는 파일은 산출물이다.
    • 코드를 통해 언제든지 다시 생성할 수 있고, 용량을 많이 차지한다.
    • 변경이력관리 포인트도 많아지고 복잡해진다.
  2. 의존성 및 패키지 폴더 (ex. node_modules/)
    • 패키지 매니저로 언제든지 설치할 수 있으므로 관리가 필요없다.
    • 모든 패키지를 다 저장하면, 수천개의 파일을 관리해야하고 용량을 많이 차지한다.
    • 의존성 설치를 위한, 의존성 내역을 관리하는 것이 더욱 효율적이다.
  3. 로그 및 임시 파일(ex. log/, *.tmp)
    • 실행 중의 동작에 따라 다른 값들이 계속 쓰여질텐데, 이를 저장하고 관리하면 복잡해진다.
    • 용량을 많이 차지한다.
  4. 개발 환경 설정 파일(ex. .env)
    • 외부로 공개되면 안되는 민감한 정보(API 키, 데이터베이스 비밀번호 등)가 적혀있어서 유출 시 보안상 위험한 파일들이다.
    • 코드에 민감정보를 그대로 기입하거나 환경설정파일을 git에서 제외하지 않아, 실제로 많은 사고가 일어났다.
    • Github 같은 곳에서는 실수로 올린 환경설정 파일들을 필터링 해주는 경우도 있지만, 조심해야 한다.
  5. IDE 설정 파일(ex. .vscode)
    • 폴더의 개발환경에 대해 에디터가 설정하는 파일이기 때문에, 개인마다 다른 파일이다.
    • 공유하게 되면, 당연히 충돌이 일어날 수 있다.

효율성 뿐 아니라, 보안측면에서도 .gitignore 를 잘 설정해줘야한다.

.gitignore 설정

gitignore 를 설정한다면, git 폴더 내부에 .gitignore 파일을 만들어서 내용을 기입하기만 하면된다.

.gitignore 에 파일명을 쓰자, 파일에 대한 추적이 끊어짐.

A.txt 가 적혀있는 .gitignore 를 만드는 순간, A.txt 에 대한 추적이 중단되었다.

Git Ignore 작성 예시

Plain Text
# .env 파일 무시
.env

# log 확장자 무시
*.log

# build 폴더와 그 하위 파일과 폴더 모두 무시
build/

# log 디렉토리 바로 아래의 파일만 무시. 폴더는 제외
logs/*

# tmp 폴더 내 tmp 확장자 무시
tmp/*.tmp

# 상단에서 *.log 를 무시한다고 했지만, A.log 는 추적
!A.log

# doc 하위의 모든 pdf 파일 무시
# doc/a.pdf 무시
# doc/sub1/b.pdf 무시
# doc/sub1/sub2/c.pdf 무시
# doc/sub1/sub2/sub3/anything.pdf 무시
doc/**/*.pdf

.gitignore 자동 생성 사이트

하지만, 개발 언어마다 만들어내는 폴더명, 빌드 산출물 등이 다른 경우가 많다.

이를 일일히 설정하기엔 문제가 많다.

이를 편하게 작성해주는 사이트가 있다.

gitignore.io — .gitignore 파일 생성기

.gitignore.io

원하는 기술 스택을 입력하면, .gitignore 파일이 나온다.

이 파일을 기반으로 추가로 커스텀하여 .gitignore 파일을 관리하면 된다.

댓글 0

이 글에 대한 생각을 자유롭게 남겨주세요.

댓글 관련 문의

댓글을 불러오는 중…

갑자기 추워진 날, 진주에서

진주에서 하루종일 돌아다녔다

양승민

내 단점을 커버하는 동료와 함께.

새로운 프로젝트를 함께 준비하는 친구와의 저녁. 미운 점도 고마운 점도 있지만, 결국 같이 잘됐으면 좋겠다는 마음.

양승민

순천과 여수 여행3

마지막 하루. 공부랑 런닝으로 끝내기

양승민
See all