[Git] .gitignore 생성, 적용 방법 정리 (macOS)

지금까지는 깃을 사용하면서도 정확한 이해는 없었던 것 같다.

오늘부터는 깃에 대해 제대로 이해하고, 깃허브, 그리고 소스트리 등을 알맞게 사용하기 위한 공부를 해보려 한다.

 

그 시작으로, 오늘은 .gitignore에 대해 공부하고 글을 작성한다.

---

☝🏻 우선, 우리가 깃을 사용하는데에는

여러가지 목적이 있지만

그 중 가장 중요한 것은 바로

히스토리, 백업, 협업

이렇게 세 가지일 것이다.

 

이 중 히스토리는

내가 어떤 것을 변경했고, 추가했고, 실수했는지까지.

모두 보여주는 지표이며 버전관리의 중요한 개념이 된다.

 

그러나, 깃허브를 이용해봤다면 모두 알 것이다...

굳이 히스토리에 올리지 않아도 될, 혹은 않아야 할 변경 사항들이 생기게 된다.

이 때, 이런 내용들까지 모두 커밋한다면 내 커밋로그는 좋은 버전관리를 시행한다고 보기 어려워질 수 있다.

 

그래서 이 문제를 해결할 수 있는 것이 바로  .gitignore이다.

(나는 지금까지 .gitignore를 몰라서 그냥 다 커밋했다,,ㅜ)

 

📎 .gitignore

항상 공식 문서가 기본!

GitHub 공식 문서에는

내 레포지터리 루트 디렉토리에 .gitignore 파일을 생성하면

커밋 시 어떤 파일, 혹은 디렉토리들을 무시할지 알려줄 수 있다고 나와있다.

 

이렇게 .gitignore를 이용하면, 내가 커밋하고 싶지 않은 내용들을 빼고! 커밋할 수 있게된다.

.gitignore을 만들고, 적용하는 방법을 알아보자.

---

📌 [ Step 1 ] .gitignore 파일 생성하기

터미널에 들어가서

cd [경로] 

명령을 사용하여 원하는 레포지터리의 루트 디렉토리로 이동해준다.

👉🏻 위에서 공식 문서에서 확인했듯이, 해당 레포지터리의 최상위 디렉토리에 생성해야한다.

(원하는 경로를 쉽게 입력하는 방법은 요기를 참고해주세요!)

 

그 다음

sudo touch .gitignore

명령을 사용하여 해당 디렉토리에 .gitignore 파일을 생성해준다.

 

여기까지 완료하고 해당 디렉토리를 확인하면, 아래 화면처럼 .gitignore 파일이 생성되었을 것이다.

그런데 여기서 아래의 흐릿한 두 파일이 안보이는 경우도 있을 것이다. (내가 그랬다.)

macOS에서는 자동으로 .으로 시작하는 파일들이 숨김 처리되어있다.

따라서 이 파일들도 보이게 설정해줘야 확인이 가능한데,

이 때는 해당 디렉토리에서 shift+command+. 키를 눌러주면 바로 해결 가능하다.

 

📌 [ Step 2 ] .gitignore 작성하기

여기까지 왔다면, 이제 .gitignore 파일에 알맞은 내용을 작성할 차례이다.

직접 작성도 가능하지만 아직 나에겐 어려워서,, 도와주는 사이트를 이용해주면 된다.

https://www.toptal.com/developers/gitignore

gitignore.io

바로 이 사이트인데,

여기에 가서 내가 원하는 키워드를 입력하면 .gitignore 파일 내용을 만들어준다.

 

내 경우에는 swift, Xcode, macOS 이렇게 세 가지 키워드를 입력했다.

본인이 해당 레포지터리에서 사용하는 언어나 도구 등을 입력해주면 된다.

 

이렇게 입력해서 '생성'버튼을 클릭해주면

위와 같이 내가 입력한 키워드에 맞는 .gitignore 내용이 만들어진다.

그럼 이제 이걸 복사해서 내가 만든 .gitignore 파일에 붙여넣으면 된다.

 

붙여넣기를 성공하면 아래와 같이 만들어지는데, 이때 또 문제가 생길 수 있다.

붙여넣기를 시도하면, 아래와 같은 오류가 발생하는 경우가 있다.

따라서 이 때는 편집이 가능하도록 설정을 변경해주어야 하는데,

우선 이 원인을 파악해보자.

 

pc 사용자의 입장에서 쓰기 편집이 가능한 파일의 경우,

아래와 같이 '정보 가져오기'를 확인했을 때

이렇게 나 자신의 권한이 읽기 및 쓰기로 되어있다.

 

하지만 우리가 편집하려고 했던 .gitignore 파일의 경우에는 위와 같은 방법으로 확인했을 때,

아래와 같이 아예 나 자신이 등록되어있지 않은 것을 볼 수 있다.

 

따라서 이 경우에는

우측 하단의 자물쇠를 열고, 좌측 하단의 +버튼을 눌러 나 자신을 추가한 후

읽기 및 쓰기 권한을 부여해주면 해결 가능이다.

이렇게 해주면 완료!

위의 과정을 끝내면 .gitignore 파일에 붙여넣기가 가능할 것이다.

 

📌 [ Step 3 ] 레포지터리에 적용하기

// 선택
sudo git rm -r --cached . // 깃 트랙킹 풀어주기
sudo git add . // 깃 커밋 할 파일 대상 설정

// 필수
sudo git commit -m ".gitignore 생성" // 커밋
sudo git push origin master // 푸시

터미널에 위와 같은 방법으로 변경 내용을 적용하면 된다.

위의 코드를 선택과 필수로 나눴는데,

 

만약 이미 생성한 레포지터리에 작업한 파일들을 올렸을 경우

그 전 작업한 내용들에도 ignoring을 적용하고 싶다면 위의 선택 코드까지 작성해주면 되고,

아직 아무 내용도 커밋하지 않았거나 그 전 작업에 대해서는 적용하고 싶지 않다면 아래 필수 코드만 작성해주면 된다.

 

여기까지 마치면

이렇게 .gitignore가 잘 적용된 모습을 확인할 수 있다.

---

이렇게 오늘은 .gitignore의 사용 방법에 대해 정리했다.

나같은 깃린이들에겐 복잡해보일 수 있지만,

꼭 필요한 내용이니 깃허브를 사용하시는 분들은 필수로! 하시길 바란다.

 

수정이 필요한 내용이 있다면 댓글 부탁드립니다! 👩🏻‍💻

---

참고

• 📖 https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files
• https://0urtrees.tistory.com/38
• https://blog.pocu.academy/ko/2019/05/16/how-to-unhide-gitignore-file-on-macos.html