2024.05.10 Today I Learned

프로젝트를 만들거나 공부를 진행할 때 보통 깃허브에 파일을 주로 올려둔다. 그런데 이번에 카카오 로그인을 진행하면서 카카오 어플리케이션을 만들어 앱 키를 사용했는데 이 앱 키는 유출이 되서는 안되는 중요한 정보다. 하지만 프로젝트를 진행하면서 앱 키를 Info.plist 에 작성한 후 아무 생각 없이 깃허브에 올려놨는데 이 앱 키가 깃허브에 그대로 올라가 버렸다... 그래서 중요 정보가 담겨있는 Info.plist 만 깃허브에서 지워야겠다는 생각이 들어 알아보았다.

그 방법은 바로 .gitignore 파일을 생성하여 그 파일에 올리면 안되는 파일경로와 파일명을 작성하면 깃허브에 올라가지 않고 다른 파일들만 깃허브에 올라가게 된다.

1. GitIgnore 파일 생성하기

우선 깃으로 연동된 루트 디렉토리에 .gitignore 파일을 생성한다.

cd <깃 루트 디렉토리>
touch .gitignore

 

2. 올라가면 안되는 파일들 작성하기

방금 생성한 gitignore 파일에서 올라가면 안되는 파일들을 작성해준다.

open -a TextEdit .gitignore

 

위의 명령어를 입력해서 텍스트 편집기 창을 열어 올라가면 안되는 파일들의 경로나 파일명을 작성해준다.

**/Info.plist
// 모든 파일에 Info.plist 라는 이름으로 저장된 파일

디렉토리 경로/~~~/~~~/Info.plist
// 현재 디렉토리 경로안에 있는 Info.plist 파일

 

위의 예제처럼 올리고 싶지않은 파일의 경로를 작성하여 하나의 파일만 올리지 않을 수 있고, "*"로 작성하여 모든 디렉토리 안에 있는 파일들을 전부 올리지 않게 설정하는 것도 가능하다.

 

3. 깃과 깃허브 연동하기

git add . 
git commit -m "Create GitIgnore"
git push -u origin main

 

gitignore 파일의 작성이 모두 완료되었다면 아래와 같이 명령어로 깃허브에 push 해주면 ignore에 작성된 파일들을 제외한 파일만 올라가게 된다.

 

이미 올라간 파일 제거하기

깃허브에 올리기 전이라면 위에 작성한 방법으로 가능하지만, 만약 미리 올려둔 상태라면 gitignore에 작성해도 지워지지 않는 경우가 존재한다. 이 때 아래의 명령어를 사용해서 파일을 깃에서만 연동을 해제시킬 수 있다.

git rm --cached 지우고싶은 파일경로 및 파일 명

 

명령어를 사용해서 깃에서 연동을 해제시켰다면 3번 명령어를 통해 깃허브에 push를 하게되면 방금 작성한 파일들은 사라지게 된다.

 

처음부터 잘 고민해서 올릴 파일과 안올릴 파일을 구분해 gitignore를 꼭 작성하여 올리면 안되는 파일을 올려버리는 불상사는 꼭 피하는걸로...