[Android] Android의 Gitignore 설정으로 commit 제한하기

출처: unsplash.com

 

내일배움캠프 최종 프로젝트 기록 1

 

 

서론

이제 기획이 어느 정도 마무리되고 본격적으로 개발을 시작한다.

프로젝트의 주제는 cosmic detox로, 우주를 콘셉트로 하는 디지털 디톡스 앱을 만들기로 했다.

그전에 먼저 초기 세팅을 진행하고 있다. 내가 맡은 초기 세팅은 패키지 구성 및 gitignore 설정, firebase와의 연결이다.

그중에서 gitignore 설정 관련해서 포스팅을 남겨 보려 한다.

이 포스팅에는 gitignore 설정 및 적용 방법을 적어 보겠다.

 

 

Gitignore

.gitignore 파일은 commit 되는 모든 파일들 중에 특정한 파일들을 commit에서 제외시켜 버리는 역할을 하는 파일이다.

gitignore 파일을 이용해 프로젝트에서 안 쓰이는 파일들을 제외시켜서 버전 관리를 용이하게 해 준다.

android studio project에서는 idea, build 파일들이 있다.

 

기본적으로는 gitignore에는 일부 idea와 모든 build 파일들이 제외돼 있다.

여기에서 나는 모든 idea 파일들을 commit log에서 제외시켜보려 한다.

 

GitIgnore 수정하기

gitignore 파일들은 여러 곳에 분포(?)되어 있다.

그중 자신이 제외시킬 파일이 있는 곳의 gitignore 파일을 수정하면 된다.

// 모든 idea 파일을 무시한다.
.idea
*.idea

// idea에서 msc.xml만 무시한다.
!idea.msc.xml

// build directory의 모든 파일을 무시한다.
build/

자주 쓰이는 것들만 적어 놓았다. 다른 example은 아래의 블로그를 참고하자.

https://velog.io/@psk84/.gitignore-%EC%A0%81%EC%9A%A9%ED%95%98%EA%B8%B0

.gitignore 적용하기

 

Gitignore 적용하기

이제 변경한 gitignore를 적용해 보겠다.

사실 gitignore를 수정하는 것은 쉽다. 다른  블로그에도 자료가 많이 나와있기 때문이다. 그런데 gitignore를 적용하는 방법에 대해서는 다양하게 나와 있지만 방법이 복잡한 방법들밖에 찾아볼 수 없었다(내가 어려운 포스팅들만 확인했을 수도 있다).

 

git command 1번만으로 gitignore를 적용해 보겠다.

우선 gitignore를 자신이 원하는 대로 설정했다는 것을 가정하고 시작하겠다.

자신이 파일을 설정한 프로젝트에 들어가 터미널 또는 git bash를 연다.

그리고 아래의 명령을 입력한다.

git rm -r --cached .

위 명령을 수행하면 아래와 같이 로그가 찍히고 android studio 상의 모든 파일들이 빨갛게(not add 상태) 변할 것이다.

 

이 상태에서 not add 상태가 된 모든 파일들을 add 해준다.

그러면 remove 되는 파일들이 나오게 되는데, 이 파일들이 gitignore를 재적용해서 github에서 제외되는 파일들이 될 것이다.

그리고 ignore가 적용된 파일들은 갈색으로 변하게 된다.

 

이제 remove 된 파일들을 commit 하고 push 하면 gitignore를 정상적으로 적용한 것이다.

 

 

정리

2년 전쯤에 gitignore를 변경해야 하는 경우가 있었는데 그때는 정확한 자료들이 없어서 적용하지 못하고 포기했어야 했다(그때도 내가 못 찾은 걸 수도).

이 방법을 알게 되면 이제 gitignore를 사용할 수 있게 될 것이다.