[Github] .gitignore 이해 및 구성 방법

해당 글의 목적은 Repository에서 소스 작업 이후 Commit & Push를 하는 경우에 특정 ‘파일’ 및 ‘경로’를 제외하여 해당 작업을 진행하고자 할때, gitignore 파일을 사용합니다.이에 대해 .gitignore에 대한 정의와 구성 방법에 대해서 익히기 위한 목적의 글 입니다.

 

 

 

STEP1: .gitignore 이해하기

---

1. .gitignore 정의

---

해당 프로젝트 내에서 불 필요하다고 느끼는 특정 '파일' 및 '디렉토리 경로'에 대해서 Repository에 올리지 않기 위해서 이 파일들을 무시(ignore)하기 위한 정보를 가지고 있는 파일(.gitignore)을 의미 합니다

 

2. .gitignore에 포함되는 정보

---

• 용량이 커서 제외 되어야 할 파일 혹은 디렉토리 경로
  Ex) npm / yarn Node 패키지 매니져 모듈을 사용하는 경우 ‘node_modules’ 디렉토리 
• 보안적인 문제에서 걸려 제외 되어야 할 파일 혹은 디렉토리 경로
• 불 필요하다고 판단 되어 제외 되어야 할 파일 혹은 디렉토리 경로

 

3. gitignore 사용법(예시)

---

// 1. '파일명'으로 제외하는 방법 (* 해당 방법은 경로 상관없이 지정한 파일명으로 모두 제외할 수 있다)
ignoreFileName.js

// 2. 특정 '파일'만 제외하는 방법 (* 현재 기준을 .ignore파일이 있는 경로라고 생각하면 된다)
src/ignoreFileName.js

// 3. 특정 '디렉토리' 기준 이하 파일들 제외 방법
node_module/

// 4. 특정 디렉토리 하위의 특정 '확장자' 제외하는 방법
src/*.txt

// 5. 특정 디렉토리 하위의 그 하위의 특정 '확장자' 제외하는 방법
src/**/*.txt

// 6. 특정 '확장자' 제외하기 
.txt

// 7. 4번 특정 '확장자'에서 일부 제외 할 파일 
!manual.txt

 

 

 

 

STEP2: .gitignore 파일 생성

---

해당 필자는 ‘Visual Studio Code’ 툴을 이용하여서 예시를 작성하였습니다.
파일 생성은 최초 Repository 생성할때, 생성을 할 수 있지만 놓치고 지나갔다면 아래와 같은 방식을 사용합니다.

 

참고) 이전에 작성한 블로그에서 최초 Repository를 생성할때,
'Add .gitignore' 옵션을 선택하면 해당 파일(.gitignore)이 생성됩니다.

프로젝트 Github 연결 방법

 

 

 

CASE1: 직접 파일을 생성하는 방식

---

1. [VSCode] 폴더의 최상위에서 오른쪽 마우스를 누른 뒤, ‘새 파일’ 버튼을 누릅니다.

---

 

2. [VSCode] 파일 이름을 ‘.gitignore’라고 지정된 이름으로 생성하면 완료가 됩니다.

---

 

 

 

CASE2: 터미널을 통하여서 생성하는 방법

---

생성하려는 Repository의 최상위에서 아래의 커맨트를 입력하면, 생성이 된다.

Command

touch .gitignore

 

 STEP3: .gitignore 내용 적기(템플릿)

---

프로젝트에서 사용 중인 OS나 언어에 대한 .gitignore 템플릿을 제공합니다

 

참고) gitignore를 필요한 내용에 대해서 받을 수 있는 사이트  

gitignore.io

 

1.  아래 사이트에서 'react', 'macOS', 'Windows'를 키워드를 입력하고 '생성' 버튼을 누릅니다.

---

 

2. 그러면 아래와 같은 파일이 도출되는데, 이 파일의 텍스트를 복사해 두어서만들어 둔 .gitignore 파일에 붙여넣기를 합니다

---

 

3. [VSCode] 저장을 하게되면,  gitignore 정보가 반영되어 최종 적용이 완료됩니다. 

---

 

+ 기타 알아가는 꿀팁

---

1. [Sourcetree] Sourcetree 를 통하여 .gitignore 파일을 생성하거나 편집 하는 방법 

Sourcetree를 사용하고 있다면.해당 Repository로 접근하여서 ‘설정’ - '고급 탭' -’편집’ 버튼을 누르면 새로운 창이 열리게 되고, 해당 창을 닫아주거나, 편집을 해도 된다. 그러면 아래와 같이 ‘.gitignore ‘파일이 생성된다.

'설정' - '고급 탭' - '편집' 버튼을 누른다.

 

해당 팝업이 뜨고, 새롭게 .gitignore 파일이 생성되며, 편집도 가능하다

 

 

2. gitignore가 작동되지 않을때 대처법

---

💡 .gitignore가 작동되지 않을때 대처법

$ git rm -r --cached .
$ git add .

 

 

3. commit/push된 파일 제외 방법

---

git rm .env --cached
git add .
git commit -m "remove .env file from git"
git push

 

4. .gitignore에서 제외할 파일

---

💡 "!" 기호를 파일명 앞에 적어두면 해당 파일은 .gitignore 파일에서 제외할 파일에서 빠집니다.

# *.keystore
!debug.keystore
my-release-key.keystore

 

 

오늘의 결론

---

- .gitIgnore파일을 통해서 최초 한번 설정을 해두고 이후 필요에 따라 특정 조건으로 제외 할 줄 안다면 편하게 프로젝트 개발을 진행 할 수 있습니다.

 

오늘도 감사합니다😀