Git04 - Git ignore

Git ignore

Why we need ignore of git

You can configure Git to ignore files you don't want to check in to GitHub.

출처 : https://docs.github.com/en/free-pro-team@latest/github/using-git/ignoring-files#excluding-local-files-without-creating-a-gitignore-file

이번에는 git ignore 설정에 대해서 설명 하려고 한다.

여러분은 프로젝트 관리를 하다 보면 프로젝트를 실행 하기 위해서 설치해야 하는 파일들이 있을 수 있다.

예를 들어서 npm으로 설치되는 파일들을 생각 해보자

(개발을 돌리기 위해 필요한 파일 명세서(pakage.json)가 있고 그 명세서에 따라서 필요한 파일들이 다운로드 된다.)

내 컴퓨터에는 프로젝트를 돌리기 위해 npm으로 설치되는 파일들이 필요하지만 이 모든걸 리모트에 올리는 것은 공간 낭비이다.

package.json 처럼 받아야 하는 물품에 대한 명세서만 있으면 다운로드 되는데 굳이 올릴 필요가 없는 것이다.

혹은, secret key 같이 프로젝트를 돌리기 위해서는 필요하지만 공유 되면 안되는 값을 가진 값들에 대해서

리모트에 올리지 말라고 한번에 설정 가능 하다. 이 기능을 git ignore 라고 보며 된다.

Set git's ignore

만드는 법은 간단하다. 현재 git을 가지고 있는 프로젝트의 최상위 디렉토리에 파일 하나마 만들어 주면 된다.

mac, unix

touch > .gitignore

window
.gitignore 파일 생성

그 후 .gitignore 파일 안에 무시하고 싶은 파일들을 최상위 디렉토리 기준으로 상대경로로 적어 주면 된다.

# Visual Studio Code # 
.vscode/* 

/*
!/foo
/foo/*
!/foo/bar

https://git-scm.com/docs/gitignore <- 링크에서 자세한 내용을 추가 적으로 확인 할 수 있다.

When set ignore of git but it be ignored

git ignore 안될 때!

가끔 ignore 설정했는데 파일이 ignore 되지 않을 때가 있다.

그럴 땐 이전에 add . 파일 과 같은 명령어를 통해서 이미 git이 관리하는 오브젝트로 파일이 관리 되고 있을 경우가 많다.

이럴 땐 git이 ignore 하고 싶은 파일에 대해서 오브젝트화를 취소 하도록 명령어를 내려줘야한다.

git에 설정된 캐쉬를 비움으로 써 위의 문제를 해결 할 수 있다.

git rm -r --cached .
git add .
git commit -m "fixed to ignore"