본문 바로가기
소소한 개발 꿀팁

[Git] .gitignore 파일이란?

by 지게요 2023. 2. 5.
728x90
반응형

깃허브에 코드를 푸시하다 보면 API 키 값, 서버 API URL 등 올려서는 안 되는 값들이 있다. 그럴 때는 .gitignore을 이용한다. 

이제부터 .gitignore파일이 정확히 무엇인지 알아보자!

# .gitignore 란? 

위에서도 간단하게 설명했지만 

  • 올려서는 안 되는 보안 키 값들
  • 프로젝트와 관련이 없는 파일 등

이러한 값을 git 레포에 올리지 않고 제외시키는 파일이다.

.gitignore 파일은 보통 깃 레포 만들 때 같이 만들어지며 프로젝트 최상위 위치에 존재하게 된다.

# .gitignore 작성 패턴

.gitignore 파일을 작성할 시 아래와 같은 패턴이 있다.

  • 표준 Glob 패턴을 사용
  • '#'로 시작하는 라인은 무시 (주석 역할)
  • 슬래시(/)로 시작하면 하위 디렉터리에 적용되지 않음
  • 디렉터리는 슬래시(/)를 끝에 사용하는 것으로 표현함
  • 느낌표(!)로 시작하는 패턴의 파일은 무시하지 않음
# 1. Glob 패턴 중 * 사용 확장자가 .txt인 파일 무시
*.txt

# 2. 윗 라인에서 확장자가 .txt인 파일은 무시 했지만 aa.txt파일은 무시하지 않음(!활용)
!aa.txt

# 3. 현재 디렉토리에 있는 bb.txt은 무시하고 src/bb2.txt처럼 하위디렉토리에 있는 파일은 무시하지 않음(/활용)
/bb.txt

# 4. src/ 디렉토리에 있는 모든 파일 무시 (디렉토리 / 활용)
src/

# bb/aa.txt 파일은 무시하고 bb/cc/aa2.txt 파일은 무시하지 않음(1,3 활용)
dd/*.txt

# dd 디렉토리 아래 모든 .txt 파일 무시
dd/**/*.txt

# .gitignore 파일 적용

적용하는 법은 간단하다

gitignore 파일에 작성 패턴 대로 적고 평소대로 커밋과 푸시를 하면 된다.

 

※ gitignore 파일 작성 할 때 편하게 대신 작성해 주는 사이트가 있어서 아래 공유 하겠다.

https://www.gitignore.io/

 

gitignore.io

Create useful .gitignore files for your project

www.toptal.com

위 링크에 들어가서 원하는 언어와 각종 설정을 추가해서 만들 수 있다.

 

참고
https://velog.io/@psk84/.gitignore-%EC%A0%81%EC%9A%A9%ED%95%98%EA%B8%B0
https://jud00.tistory.com/entry/Git-gitignore-%ED%8C%8C%EC%9D%BC%EC%9D%80-%EB%AD%98%EA%B9%8C-%EA%B7%B8%EB%A6%AC%EA%B3%A0-%EC%96%B8%EC%A0%9C-%EC%82%AC%EC%9A%A9%ED%95%A0%EA%B9%8C
https://programming119.tistory.com/105
반응형