gitignore 작성 방법

mangojang·2022년 12월 15일
0
post-thumbnail

✍️ node_module, .next , .env 등 빌드 시 자동으로 만들어지는 크기가 큰 폴더들, 보안 관련 파일들은 git에서 관리 되면 안된다. git이 무시 할 폴더, 파일을 설정하는 gitignore에 대해 정리 해 보았다.

.gitignore 란?

  • 특정 파일이나 폴더를 무시하도록 설정 하는 문서
  • git에 의해 변경 내역이 추적 되지 않음.

기입하는 문서

  1. 빌드 시 나 런타임에 자동으로 생성되는 파일이나 폴더 ex) node_module
  2. 임시 리소스 ex) 캐시 파일, 로그 파일
  3. 타인과 공유하면 안되는 설정 파일
  4. 암호 키, credential 파일

작성 방법

# 주석: #으로 시작 하는 줄

# 1. 파일ignore 처리 - 'file.ext'라는 파일 ignore
file.ext

# 2. 특정 경로의 파일 ignore 처리
dir/otherdir/file.ext

# 3. (프로젝트 전체 기준) 폴더 전체 ignore 처리 - 폴더명/
node_module/

# 4. (현재 폴더 경로 기준) 폴더 전체 ignore 처리 - /폴더명
/node_module

# 5. 특정 문자 포함하는 경로 ignore 처리 - [특정문자1, 특정문자2]
# ex) build/, Build/ 둘다 적용
[bB]uild/

# 6. 특정명의 파일, 폴더 전체 ignore - 파일or폴더명만 씀.
# ex) node_module 이라는 이름을 가진 파일 or 폴더들 전체 ignore
node_module

# 7. 확장자별 ignore 처리 - .확장자명
# .apk 확장자를 가진 모든 파일들 ignore
.apk

# 8. 어떤 위치에 있는 특정 폴더 ignore 처리 - ##/폴더명/
# 뒤에 / 를 안붙이면 dirA라는 파일도 ignore 처리 됨.
# ex) dir/dirA 의 모든 파일, dir/dirB/dirA의 모든 파일 적용
**/dirA/ 

# 8. 특정폴더A 하위에 존재하는 특정폴더B ignore 처리 - 특정폴더A명/**/특정폴더B명/ 
# ex) dirA/dirC/dirB의 모든 파일, dirA/dirC/dirD/dirB의 모든 파일 적용
dirA/**/dirB

# 9. 특정 폴더 바로 하위에 존재하는 특정 확장자파일 전체 ignore 처리 - 특정폴더명/*.확장자명
# ex) dir/a.txt, dir/b.txt 모두 적용됨.
dir/*.txt

# 10. 특정 폴더 하위에 존재하는 특정 확장자파일 전체 ignore 처리 - 특정폴더명/**/*.확장자명
# ex) dir/dirB/a.txt , dir/dirC/dirD/b.txt 모두 적용됨.
dir/**/*.txt

# 9. ignore 예외 처리 - !파일명
!file.ext

참고 문헌

profile
한 걸음 한 걸음 계속 걷는 자가 일류다

0개의 댓글