gitignore 개념과 작성하는 방법

.gitignore 란?

• 사용자가 git에 등록(commit)되지 않길 원하는 파일 또는 폴더들의 목록을 저장하는 곳
  💡 예를들어 비밀번호가 들어있는 파일이나 쓸데없이 용량만 큰 파일들 또는 보안 관련 파일들을 저장한다.
• .gitignore 에 등록된 파일(폴더) 들은 커밋 시 자동으로 제외된다.

gitignore 작성법

1. #은 주석의 역할을 한다.
2. 폴더 : /폴더명 (예 : /docs)
3. 파일 : 파일명.확장자 (예 : test.txt)
4. 폴더 안 파일 : /폴더명/파일명.확장자 (예 : /docs/test.txt)
5. 폴더 안 특정 확장자 파일 전부 (예 : /docs/*.text)
6. 폴더 하위 모든 특정 확장자 파일 전부 (예 : /docs/**/*.txt)

.gitignore 작성에 유용한 템플릿 사이트

gitignore.io

React 프로젝트에 대해서 gitignore을 작성한다고 가정하여 React를 검색 후 나오는 아래 사진의 내용을 전부 복사하여 .gitignore 파일에 붙여 넣는다.

react 프로젝트에 대한 gitignore 템플릿

.gitignore에 폴더 및 파일을 어떻게 등록하는지 알아보자! 필자는 VS Code 에디터 환경에서 .gitignore 파일을 생성하여 진행하였다.

.gitignore 작성

test.txt를 등록하였더니 탐색기에서 파일명이 회색으로 변경된 모습.

💡.gitignore에 등록되지 않은 파일은 에디터에서 파일명이 초록색으로 표시되며, .gitignore에 등록된 파일의 파일명은 회색(죽은 파일)으로 표시된다.

• docs 폴더를 생성 후 폴더 안에 test1.txt 와 test2.txt 파일 생성

폴더안에 특정 파일만 gitignore에 등록하고 싶을때에는 위와 같이 경로를 직접 작성해준다.

• docs 폴더 안에 test3.js 파일 생성하여 txt 확장자를 가진 파일만 gitignore에 등록

특정 확장자를 가진 파일 전부를 gitignore에 등록하고 싶을때는 별표(*)를 이용하여 *.확장자 형태로 작성한다.

• docs 폴더안에 존재하는 JS 확장자를 가진 파일에 대해서만 gitignore에 등록

위와 동일한 방법으로 JS 확장자를 가지는 파일에 대해서만 gitignore에 등록한 모습.

• docs 폴더 안에 docs 폴더의 하위폴더인 docsUnder 폴더 생성 후 docsUnder 폴더안에 test4.txt 파일 생성

docs 폴더안에 하위폴더가 존재하지만 경로를 지정해주지 않아서 하위폴더 안에 존재하는 파일까지는 영향을 미치지 못한다.

• docs 폴더의 하위 폴더까지 경로를 지정해줘서 하위폴더 docsUnder 폴더 안에 존재하는 test4.txt 파일 등록

하위폴더의 경로를 지정해주기 위해서는 별표2개(**)를 이용하여 /** 형태로 작성한다.

---

💡.gitignore 작성 팁

초기 세팅을 하기 위해서 gitignor.io에 접속하여 자신이 진행 중인 프로젝트에 일반적인 gitignore 템플릿을 복사해서 .gitignore파일에 붙여 넣고 특정하게 등록하고 싶은 파일을 추가로 등록하는 방법이 이상적이다. 예를 들어 Swift로 IOS 개발을 하고 있다고 가정하면 Swift를 검색한 후 해당 내용을 복사하여 .gitignore에 붙여 넣는다. 그 후에 추가적으로 등록하고 싶은 게 생기면 주석을 달아서 작성한다. 예시)gitignore에  Swift 프로젝트 등록 및 test3.js 파일 등록

gitignore.io 페이지에 Swift 검색 후 해당 템플릿 VS Code에 붙여넣기

• Swift 프로젝트를 생성했다고 가정하여 템플릿을 붙여 넣은 후 docs 폴더 안에 존재하는 test3.js 파일을 등록하고자 할 때

맨 밑줄에 주석을 달아서 등록하고 싶은 파일을 작성한다.

이렇게 하여 gitignore 작성 방법을 알아보았다!