처음 “git ignore“는 모르고 git을 사용했을 때가 생각납니다. “git add .” 명령어가 얼마나 편하던지… 해당 명령어를 애용하던 때가 있었습니다.
하지만 git add . 명령은 현재 디렉토리에 있는 모든 변경된 파일들을 스테이징 영역으로 추가합니다.
이는 모든 변경 사항을 일괄적으로 스테이징할 때 유용한 명령어이지만 원하지 않은 파일들도 모두 git에 저장할 수 있는 오류를 범할 수 있습니다. (git 세계의 rm -rf 랄까…)
예를 들면, 로그 파일, 텍스트 파일, 테스트 파일, 주피터 노트북 등 원하지 않는 데이터도 git에 올라갈 수 있게 됩니다.
이런 불상사를 막기 위해 .gitignore 가 존재합니다.
.gitignore 파일은 Git으로 관리되는 저장소에서 제외되어야 할 파일 및 디렉토리를 명시하는데 사용됩니다.
이번 포스트에서는 gitignore를 사용하는 이유, 설정 법을 간단하게 정리해보았습니다.
Git ignore 를 사용하는 이유
| 이유 | 설명 |
|---|---|
| 보안 | API 키, 비밀번호, 로컬 설정 파일과 같은 민감한 정보를 제외하여 보안을 유지합니다. |
| 불필요한 파일 제외 | 빌드 파일, 로그 및 캐시 파일과 같은 소스 코드와 관련이 없는 파일을 제외하여 저장소를 유지하고 불필요한 용량을 피합니다. |
Git ignore 설정
로컬 저장소의 워킹 디렉토리에 .gitignore 파일을 생성함으로써 저장소에서 제외해야 할 파일 및 디렉토리를 지정할 수 있습니다.
.gitignore 내용 작성
아래와 같은 형식으로 내용을 작성하여 해당 내용을 .gitignore 라는 파일명으로 워킹 디렉토리에 저장하면 됩니다.
# : comments
# no .a files
*.a
# ignore에 했더라도 해당 포맷은 제외
!lib.a
# 특정 디렉토리는 무시
디렉토리명/
# ignore doc/notes.txt, but not doc/server/arch.txt
doc/*.txt
# ignore all .pdf files in the doc/ directory
doc/**/*.pdf자동으로 gitignore 생성
아래 웹사이트를 이용하면 빠르게 git ignore를 생성해줍니다.
gitignore.io – 자신의 프로젝트에 꼭 맞는 .gitignore 파일을 만드세요 (toptal.com)
개발 환경만 입력하면 자동으로 gitigore파일을 만들어주는데요. 예를 들어, 아래와 같이 windows, visual studio code를 입력하면
자동으로 아래와 같이 vs code나 window에서 나올 수 있는 덤프파일, 캐시파일들이 입력된 gitignore를 만들어 줍니다.
### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
!.vscode/*.code-snippets
# Local History for Visual Studio Code
.history/
# Built Visual Studio Code Extensions
*.vsix
### VisualStudioCode Patch ###
# Ignore all local history of files
.history
.ionide
### Windows ###
# Windows thumbnail cache files
Thumbs.db
Thumbs.db:encryptable
ehthumbs.db
ehthumbs_vista.db
# Dump file
*.stackdump
# Folder config file
[Dd]esktop.ini
# Recycle Bin used on file shares
$RECYCLE.BIN/
# Windows Installer files
*.cab
*.msi
*.msix
*.msm
*.msp
# Windows shortcuts
*.lnk참고하면 좋은 글
