평소처럼 Github에 커밋한 후에 메일한통이 왔다. WeatherApp을 만들어보면서 사용했던 OpenWeatherMap Api Token이 노출되었다는 경고다. 그럼 우리는 Github에 파일을 커밋할 때 어떻게 중요한 정보들을 숨길 수 있을까? 바로 gitignore 기능을 사용한다면 간단하게 숨길 수 있다.

.gitignore란?

Git 버전 관리에서 제외할 파일 목록을 저장하는 파일이다!
Git으로 프로젝트를 관리할 때, 프로젝트안의 특정 파일들은 Git으로 관리할 필요가 없는 경우가 있다. 또한 외부로 공개시키지 않아야할 파일들을 gitignore에 파일명을 기재하면 된다 :)

주의할 점

숨길 파일을 먼저 생성하고 gitignore파일을 작성하면 Sourcetree에서 숨길 파일을 먼저 인식해버리는 경우가 있다.
Sourcetree특성인것 같다. 물론 gitignore파일에 먼저 등록해주고 숨길 파일을 생성하면 문제가 없지만..
이럴 경우에는 파일을 잠시 지웠다가 다시 생성해주면 Sourcetree가 정상적으로 인식해 준다!

.gitignore 파일 만들기

필자는 Sourcetree를 사용하고 있기 때문에 Sourcetree기준으로 설명하겠다.

gitignore 파일 생성을 원하는 Repository를 Sourcetree에서 열고 우측 상단에 설정버튼을 눌러보자.

고급 탭에서 저장서별 무시 목록에 편집버튼을 클릭한다.

숨기고 싶은 파일명을 작성후 저장해준다!
물론 파일명 뿐만아니라 폴더명도 작성 가능하다.

이로써 숨길 준비는 되었다. 그럼 이제 숨겨보자~

Swift 파일 수정하기

숨길파일 만들기

필자는 ApiKey를 저장하기 위한 Storage.swift파일을 하나 생성 후 key를 저장해 주었다.

key가 사용되어야 할 부분에 이런식으로 호출을 해주면 완료

수정후엔 테스트도 필!수!

아주 잘 나온다.

이후 Sourcetree에서 .gitignore에 작성된 파일이 보이지 않는것을 확인 할 수 있었다.

⭐️ 주의사항 ⭐️

기존의 git의 관리를 받고 있던 파일이나 폴더를
.gitignore 파일에 작성하고 add > commit > push 하여도
ignore(무시) 되지 않는다.

이럴때는 기존에 가지고 있는 cached를 치워야 합니다.
다음과 같은 명령어를 실행해주면 된다. (출처: https://kcmschool.com/194 )