git의 관리에서 제외하기 [.gitignore]

 

 

 

---

 

git에서 관리를 할 때 관리를 하지 않아야 하는 파일들이 있다.

이러한 파일들을 어떻게 제외할까?

 

 

---

 

 

 

git의 관리에서 특정 폴더 또는 파일을 제외하려면 .gitignore파일을 사용하면 된다.

 

.gitignore파일은 git에 등록을 배제하고 싶은 폴더 또는 파일을 명시하여 

 

git에게 해당 폴더 또는 파일을 등록(관리) 하지 말라고 전달해 준다.

 

 

 

 

.gitignore파일에 작성하여 git에 등록을 제외하는 파일들은

 

굳이 git에 포함할 필요가 없는 파일과 포함하면 안 되는 파일이 있다.

 

 

예시로

 

프로젝트를 실행하면 자동으로 생성되는 build 결과물,

 

외부에서 직접 다운로드가 가능한 라이브러리 등은

 

git에 용량만 차지하게 되므로 굳이 등록을 안 하는 파일들이고

 

파일 내부에 보안상으로 민감한 정보들이 담긴 파일들 또한 git에 등록하면 나중에 다른 곳에 공유할 때 

 

유출될 우려가 있어서 git에 등록할 때 제외한다.

 

 

 

 

보통 프로젝트 파일을 만들면 기본적으로 최상위 위치에 .gitignore파일이 생성된다.

 

만약 없다면 직접 만들어주면 된다.

 

 

 

기본적으로 생성된 .gitignore파일의 내용을 보면 기본적으로 git에서 제외할 파일들이 명시되어 있다.

 

HELP.md
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/

### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
bin/
!**/src/main/**/bin/
!**/src/test/**/bin/

### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
out/
!**/src/main/**/out/
!**/src/test/**/out/

### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/

### VS Code ###
.vscode/

 

 

 

.gitignore파일에 작성하는 형식

https://git-scm.com/docs/gitignore

Git - gitignore Documentation

 

 

 

 

.gitignore의 형식에서 기본적인 것만 추려서 예시를 보여주면 다음과 같다.

 

 

주석 처리 명령어

# 이렇게 주석을 사용한다.

 

 

특정 파일 (hello.txt)를 git의 관리에서 제외

hello.txt

 

 

최상위 폴더의 위치에서 특정 파일 (hello.txt)를 git의 관리에서 제외

/hello.txt

 

 

모든 .txt 확장자 파일을 git의 관리에서 제외

*.txt

 

 

제외하지 않을 파일 (*.txt로 txt 확장자를 모두 제외했지만 hello.txt파일은 제외하지 않는다.)

!hello.txt

 

 

test라는 이름을 가진 파일 또는 폴더와 해당 폴더의 내용들을 모두 제외 

(확장자를 생략하면 해당 이름의 폴더까지 포함된다.)

test

 

 

test라는 이름의 폴더와 그 내용들을 모두 제외

(마지막에 /가 있으면 파일이 아닌 폴더를 의미한다.)

test/

 

 

test폴더 안에 바로 위치하고 있는 hi.txt 파일을 제외

test/hi.txt

 

 

test폴더 안에 또는 그 안의 폴더 안에 있는 delete.txt파일을 제외

(test폴더 안에 깊숙한 곳까지 포함하여 모든 delete.txt파일을 의미한다.)

test/**/delete.txt

 

 

 

 

---

참고 및 출처

• https://www.inflearn.com/course/%EC%A0%9C%EB%8C%80%EB%A1%9C-%ED%8C%8C%EB%8A%94-%EA%B9%83