[TIL, 일일 회고] 2024.09.08 - 인적 오류로 인한 .idea 폴더 커밋 문제 해결: .gitignore 설정의 중요성

 

 

개요

프로젝트를 시작할 때, 조직을 만들고 레포지토리를 생성한 후 초기 세팅을 레포지토리에 커밋했습니다.

 

그러나 처음 커밋할 때 실수로 .idea 폴더를 함께 올려버렸습니다. 이로 인해 이후 팀원들이 pull을 받을 때 각자의 IDE 설정, JDK 버전 등이 맞지 않아 에러가 발생했습니다.

 

본 글에서는 .idea 폴더와 관련된 문제를 정리하고 해결 방법에 대해 설명하겠습니다.

 

 

.idea란❓

.idea 폴더는 IntelliJ IDEA에서 프로젝트 설정을 저장하는 디렉토리입니다. 이 폴더는 프로젝트와 관련된 다양한 설정 파일을 포함하고 있습니다.

• 프로젝트 구조와 설정: 프로젝트의 모듈, SDK 설정, 빌드 설정 등을 포함합니다.
• IDE 사용자 설정: 각 사용자의 인터페이스 설정, 코드 스타일, 템플릿 등을 저장합니다.
• 플러그인 설정: 설치된 플러그인과 관련된 설정을 포함합니다.
• Workspace: 작업 중인 파일, 편집 중인 내용 등의 임시 정보가 저장됩니다.

 

 

.idea 폴더를 깃에 포함하지 않는 이유

1. 개인화된 설정
   •  .idea 폴더에는 개인적인 IDE 설정이 포함될 수 있으며, 이러한 설정은 팀원 간에 일관되지 않을 수 있습니다.
2. 환경 의존성
   • 각 개발자의 IDE 설정, 플러그인, JDK 버전 등이 다를 수 있어, 이로 인해 충돌이나 불필요한 설정 변경이 발생할 수 있습니다.
3. 비공식 파일
   • IDE 관련 파일은 프로젝트의 코드와 직접적으로 관련되지 않는 경우가 많아, 버전 관리에서 제외하는 것이 일반적입니다.

그래서 일반적으로 .idea 폴더는 .gitignore에 추가하여 깃 레포지토리에서 제외하는 것이 좋습니다.

 

문제사항 해결과정

 

현재 위와 같이 깃 레포지토리에 .idea폴더가 포함되어 올라갔습니다. 따라서 팀원들이 pull받을 때 에러가 발생했기 때문에 다음과 같은 작업이 필요합니다.

 

1. .gitignore 파일에 .idea/ 추가

.gitignore 파일에 .idea/ 폴더를 추가합니다. .gitignore 파일이 없으면 프로젝트 루트 디렉토리에 새로 만듭니다.

# IntelliJ IDEA 관련 설정 무시
.idea/

 

2. Git에서 .idea 폴더를 제거

git rm -r --cached .idea
git commit -m "Remove .idea folder from repository"

 

 

3. 변경사항 push

git push origin main

 

이렇게 하면 깃 레포지토리에서 .idea 폴더가 제거되고, .gitignore에 의해 이후에는 .idea 폴더가 다시 커밋되지 않게 됩니다.

---

이와 같이, 인적 오류로 인해 .idea 폴더와 같은 개인 설정 파일이 깃 레포지토리에 포함되는 문제가 발생할 수 있습니다. 이를 방지하기 위해 .gitignore 파일을 올바르게 설정하는 것이 매우 중요합니다.