[Git/GitHub] - GitHub에 잘못 올라간 파일 제거하기(.gitignore)

📎  GitHub에 잘못 올라간 파일 제거하고 .gitignore에 추가하기

 

저는 평소에 작업을 하다가 실수로 불필요한 파일까지 GitHub에 올린 경우가 있었습니다.

 

예를들면 다음과 같은 사항들이 존재합니다.

• NodeJS의 npm module
• Java의 target폴더 하위 파일들(.class)
• 민감한 정보들(DB정보, AWS 비밀 키 등등)

 

특히나 세 번째의 민감한 정보들을 GitHub에 잘못해서 올렸을 경우, 가끔 해당 정보를 이용해 AWS의 폭탄 과금을 맞는다는 글을 몇 번 본적이 있었는데요, 따라서 더 주의해야 합니다.

 

위와 같은 내용들은 .gitignore 라는 파일에 추가를 해야합니다.

 

.gitignore란 ?

.gitignore란 간단히 말해 Git 버전 관리에서 위의 사항들처럼 제외할 파일 목록을 지정하는 파일입니다.

.gitignore 파일에 추가하면 GitHub에 해당 내용을 추가하지 않습니다.

 

 

* 인텔리제이에서 gitignore 파일을 생성하는 방법은 아래 링크를 참고해주세요 :) 

https://elevatingcodingclub.tistory.com/72

[Git] IntelliJ에서 .gitignore 사용하기(commit 대상에서 제외하기)

 

 

 

GitHub에 잘못 올라간 파일 삭제

1) 먼저 원격 저장소에서 파일을 삭제합니다.

// 원격 저장소 및 로컬 저장소의 파일을 삭제합니다.
$ git rm -r [File Name]

// 원격 저장소에 있는 파일만 삭제합니다.(로컬 저장소의 파일은 삭제되지 않습니다.)
$ git rm --cached -r [File Name]

--cached 명령어는 원격저장소의 폴더 및 파일을 삭제한다고 알려주는 옵션입니다.

따라서 만약 --cached 옵션을 추가하지 않고 rm을 할 경우, 원격 저장소 및 로컬 저장소에서 전부 파일을 삭제해버리게 됩니다.

보통 gitignore에 추가하는 내역들은 원격 저장소에만 삭제하고, 로컬 저장소에는 해당 폴더 및 파일을 가지고 있기 때문에

--cached 옵션을 추가해서 사용합니다.

 

 

 

저는 위 사진에서 .idea 폴더를 원격에서는 삭제하고, 로컬에는 그대로 놔둘 예정이기 때문에 git rm --cached -r를 사용합니다.

// .idea 폴더 하위의 모든 파일 삭제
$ git rm --cached -r .idea/

 

 

 

2) 다음으로 .gitignore 를 설정합니다.

gitignore 생성 사이트 를 통해 해당 프로젝트에 맞는 .gitignore 코드를 자동으로 생성할 수도 있습니다.

또한 IntelliJ 에서는 gitignore 플러그인 이 존재하기 때문에 간단히 클릭만으로 gitignore에 파일을 추가할수도 있습니다. 😃

 

.gitignore 파일을 생성하고, 위에서 제거한 .idea 폴더를 추가합니다.

위 사진에서 .idea 폴더의 색상이 주황색으로 된 걸 확인할 수 있는데 위와 같이 주황색의 폴더가 Git 버전 관리에서 제외할 폴더입니다.

 

 

 

 

3) 마지막으로 원격 저장소에 적용(Push) 해줍니다.

Git 버전관리에서 완전히 제외하기 위해서는 위 1~2 과정을 끝낸 후 commit & push를 해주어야 합니다.

// 버전 관리에서 완전히 제외하기 위해 commit
$ git commit -m "Fixed untracked files"

// 원격 저장소(origin)에 push 진행
$ git push origin

 

 

저의 git status 상태인데요, 저는 현재 다른 파일들도 함께 존재하기 때문에 제외한 파일들을 직접 커밋했습니다.

 

 

위와 같이 삭제된 파일들을 commit & push 를 진행합니다.

 

 

 

push를 하고 GitHub를 확인해보면 .idea 폴더가 완전히 삭제된 걸 확인할 수 있습니다! 😊

 

인텔리제이 기준으로 .idea 폴더나 target폴더도 보통 gitignore 파일에 추가하지만,

특히 민간함 정보들은 꼭 gitignore 파일에 추가해서 GitHub에 올리지 않도록 수정해야 합니다!

 

 

 

 

 

References

• https://gmlwjd9405.github.io/2018/05/17/git-delete-incorrect-files.html
• https://elevatingcodingclub.tistory.com/72