[Git] .gitignore 사용하기

포스팅 개요

 Project를 진행하다 보면 올리고 싶지 않은 파일이나, 보안상 올리면 안 되는 파일도 있습니다. 그럴 때 .gitignore 파일을 사용하면 문제를 해결할 수 있습니다.

---

포스팅 본문

1. .gitignore 파일 만들기

 .gitignore 파일은 항상 Directory의 최상위에 위치해야 합니다.

아래와 같이 간단하게 메모장 파일을 하나 만들어서 .gitignore으로 저장해주면 됩니다.

 

.gitignore

2. 문법

# .a로 저장된 파일 모두 ignore
*.a

# 위의 문법으로 .a 파일을 모두 ignore하더라도, lib.a는 제외
!lib.a

# TODO 폴더 위치의 파일만 ignore하고, TODO의 하위폴더는 ignore하지 않음 
/TODO

# build 폴더 안의 모든 파일 ignore, venv/나 .ipynb_checkpoints/ 폴더 ignore시 유용
build/

# doc/notes.txt는 ignore하나 doc/server/arch.txt는 ignore하지 않음
doc/*.txt

# doc 폴더의 모든 .pdf 파일 ignore
doc/**/*.pdf

3. 적용시키기

 평소 git 사용할 때처럼 .gitignore 파일을 add, commit, push 해두면 앞으로 적용됩니다. 하지만 기존에 있던 파일들에도 .gitignore을 적용하고 싶다면 다음의 코드를 실행하면 됩니다.

git rm -r --cached .
git add .
git commit -m "Apply .gitginore"

---

 저는 data 폴더에 작업 데이터 파일들을 올려두는 편인데, 보안상의 이슈 때문에 git에 업로드를 못하곤 했습니다. .gitignore File 덕분에 데이터 파일, ipynp_checkpoints/, venv/ 폴더를 ignore 하고 git을 더 잘 활용하게 되었습니다. 이 글을 보신 여러분께도 도움이 되셨길 바랍니다. :)