git rm --cached 커밋에 포함된 파일 제거하기

 

프로젝트를 초기 생성하고 Git에 올리는 과정에서 build 관련 폴더까지 같이 commit이 되었다.. (제대로 확인 안 하고 커밋한 내 잘못…..)

팀원들에게 도움을 청하니 캐시 삭제가 가능하다고 해서 시도해봤다.

팀원분이 알려주신 명렁어는

git rm -r -f --cached . 이다.

 

 git rm --cached  명령어는 Git의 스테이징 영역에서 파일을 제거하고, 로컬 파일은 보존하는 명령어이다.

즉, Git이 파일을 더 이상 추적하지 않는다.

따라서 다음과 같은 상황에 쓰일 수 있다.

1. 잘못 커밋된 파일 제거
   • .gitignore에 추가해야 했던 파일을 실수로 커밋한 경우
2. 민감한 정보 제거
   • 비밀번호나 API 키가 포함된 설정 파일이 저장소에 추가된 경우
3. 대용량 파일 제거
   • 저장소에 불필요하게 큰 파일이 추가된 경우
4. gitignore 변경 후 적용
   • gitignore 파일을 변경했을 때 이미 추적 중인 파일에는 적용되지 않으므로 해당 명령으로 추적 중단

 

 

명령어 형식과 옵션

git rm --cached [옵션] <파일 또는 패턴>

— 주요 옵션

• r, -recursive: 디렉토리와 하위 내용까지 제거
• f, -force: 인덱스와 작업 트리에서 수정된 파일도 강제로 제거
  • Git은 수정했지만 아직 커밋하지 않은 파일은 제거하지 않는다.
  • 이 옵션을 사용하면 이를 무시한다.
• -ignore-unmatch: 일치하는 파일이 없어도 오류를 반환하지 않음

 

사용 예제

단일 파일 제거

git rm --cached config.json

디렉토리와 그 내용 제거

git rm --cached -r build/

특정 패턴의 파일 모두 제거

git rm --cached *.log

 

git rm과 git rm —cached 차이점

• git rm: 파일을 인덱스와 작업 디렉토리 모두에서 제거 (실제 파일 삭제)
• git rm --cached: 파일을 인덱스에서만 제거 (실제 파일은 유지)

 

작업 흐름

git rm --cached <파일명>

git commit -m "커밋 메시지"

git push origin <브랜치명>

 

여기서 도르마무가 되었던 이유

$ git rm -r -f --cached gradle/wrapper/

$ git status
On branch master
Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
        deleted:    gradle/wrapper/gradle-wrapper.jar
        deleted:    gradle/wrapper/gradle-wrapper.properties
Untracked files:
  (use "git add <file>..." to include in what will be committed)
        gradle/
        
$ git add .

$ git commit -m "init setting"
On branch master
nothing to commit, working tree clean

이렇게 작업한 후 push 했는데 제외하고 싶었던 폴더가 git에 올라갔다.

아마도.. git add . 를 실행하면서 제거한 파일이 다시 추가되는 상황이 펼쳐진 것 같다.

나중에 git add 를 제외하고 작업했더니 폴더를 제외시킬 수 있었다.

 

주의 사항

1. 파일을 추적하지 않는다는 것은 앞으로의 커밋에서만 제거하기 때문에 이전 커밋 히스토리에는 존재한다.
2. 팀 프로젝트에서는 다른 팀원들과 공동 작업하는 것이기 때문에 주의해야 한다.
3. 민감한 정보가 이전 커밋에 포함된 경우에는 히스토리를 재작성하는 작업이 필요하다. (이전 커밋 히스토리는 존재하기 때문에)
   • 근데 커밋 히스토리 재작성하기는 어렵기 때문에 거의 불가능한 것 같다……
   • 민감한 정보면 해당 정보를 변경하거나 레포를 다시 하는 게 가장 빠르지 않을까…