처음 IntelliJ로 개발을 하다 보면 Git에 자동으로 올라가는 IntelliJ IDEA 관련 파일들 때문에 고민이 많을 거예요.
특히 .iml과 .idea 폴더는 올려야 하나? 말아야 하나? 정말 헷갈립니다.
이 포스팅에서 왜 무시해야 하는지, 어떻게 깔끔하게 정리하는지 확실하게 정리해보겠습니다.
.iml 파일과 .idea 폴더는 뭐하는 파일일까?
.iml 파일
IntelliJ IDEA가 프로젝트 모듈 정보를 저장하는 파일입니다. 프로젝트 구조, 라이브러리, SDK 등의 정보가 들어있어요.
.idea 폴더
IntelliJ IDEA가 프로젝트 전반의 설정 파일들을 저장하는 폴더입니다. (코드 스타일, 실행 설정, UI 환경 등 개발자 개인 환경에 맞춰지는 경우가 많음)
Github에 커밋해야 할까?
❌ 보통은 커밋 안 하는 게 원칙입니다!
- .iml과 .idea 폴더는 개발자 개인 설정이 많아서 팀원마다 다를 수 있습니다.
- 팀원 간에 충돌이 날 확률이 높고, 서로 다른 환경이 꼬일 수 있어요.
- 대부분의 경우 프로젝트 빌드에는 전혀 영향이 없기 때문에 커밋하지 않는 게 기본!
언제 커밋할까?
- 팀 전원이 IntelliJ IDEA만 사용하고,
- 동일한 개발 환경을 유지해야 하는 경우에는 커밋하는 경우도 있어요.
그럼 어떻게 커밋에서 제외시킬수있나?
✅ gitignore에 아래 내용을 추가하면 깔끔하게 해결됩니다.
.idea/
*.iml
이미 커밋된 .idea, .iml 파일 삭제하는 법 (GitHub에서 지우기)
1. .gitignore 파일에 무시 규칙 추가하기
.idea/
*.iml
2. Git이 추적 중인 파일을 추적 해제하기
git rm -r --cached .idea
git rm --cached Java_learn.iml
3. 변경사항 커밋하기
git commit -m "Remove .idea folder and .iml file from repository"
4. 원격 저장소에 푸시하기
git push origin main브랜치 푸시할때 오류 해결방법 [https://dlscks0930.tistory.com/115 ]
정리
- .idea/와 *.iml은 GitHub에 커밋 안 하는 게 기본
- 처음부터 .gitignore를 잘 설정하면 실수로 올릴 일 없음
- 이미 올라갔다면 git rm --cached로 추적 해제 후 삭제하고 커밋하면 깔끔하게 해결됨