[github] .gitignore 파일로 특정 포맷의 파일 무시하기

 

우리가 Version Controll 을 위해서 git 을 사용하고 git hosting 으로 github 를 사용하면 보안적으로나 개인적으로 올라가면 안되는 파일들이 존재한다.

 

이를테면 간단한 key 파일이라던지, 개인적인 정보가 담긴 data 파일이라던지 혹은 test 를 위해 build 를 하는 build 파일이라던지..

 

이렇게 원치 않는 파일을 git 에 올리는 방법에는 여러 방법이 있지만 오늘은 .gitignore 이라는 파일을 이용하는 방법에 대해서 알아보도록 하자

 

.gitignore 이란?

 

.gitignore 은

 

프로젝트 Repository 에 원치 않는 file 및 데이터를 git 에서 제외시키는 설정이 담긴 파일을 의미한다.

 

우리가 Springboot 로 프로젝트를 생성하면 자동으로 생기는 .gitignore 이라는 파일이 자동으로 생성된다.

 

 

그리고 세부 내용은 다음과 같은데,

 

 

이는 Spring Boot 로 애플리케이션을 빌드할 때 생성되는 .out 디렉토리에 담기는 내용이 너무 많아져서 git 에 올라갈 필요가 없기 때문이다.

 

이와 마찬가지로 우리는 github 에 build 하는 target 파일들을 올릴 필요가 없다.

 

.gitignore 파일 생성 규칙 및 문법

 

.gitignore 파일은 항상 프로젝트 루트에 위치해야 한다

 

# : 주석

*.a # 확장자가 .a 인 모든 파일을 제외한다.

!lib.a # *.a 로 확장자 .a 를 모두 exclude 시켰지만 꼭 올라가야 할 .a 파일은 추가한다

build/ # build 디렉토리에 있는 모든 파일을 제외시킨다

doc/*.md # doc 디렉토리 아레에 있는 *.md 확장자 파일을 exclude 한다

 

실제로 적용하기

 

실제로 BoB 과제인 add-nbo 소스 코드를 github 에 저장하는 과정을 보이도록 하겠다.

 

해당 로컬 레포지토리에는 다음과 같은 구조로 파일들이 존재하고, 해당 파일을 BoB-Assignments / add-nbo 레포지토리 에 올리려 한다.

 

$ tree
.
└── add-nbo
    ├── main.c
    ├── file_util.h
    ├── file_util.c
    └── Makefile

 

리눅스 빌드 도구인 Makefile 에서 빌드를 수행하면 2 개의 Object file 을 생성한다.

 

• file_util.o
• main.o

$ ls

main.c   main.o   file_util.h   file_util.c   file_util.o

 

이러한 오브젝트 파일은 github 에 올릴 필요가 없으므로 아래와 같이 .gitignore 파일을 생성한다.

 

# .gitignore

### object 파일 무시
*.o

 

그리고 git add, commit, push 를 해서 원격 레포지토리에 올려보면, 

 

 

그럼 build 를 하더라도 Object 파일은 모두 무시되고, c와 h 확장자 파일만 정상적으로 잘 올라가게 된다.