GIT .gitignore 사용법 및 작동하지 않을 때 해결 방법
안녕하세요. 파파대니입니다.
Git을 사용하다 보면 불필요한 파일이 커밋되어 코드베이스가 어지러워지거나, 중요한 정보가 포함된 파일이 실수로 공개되는 일이 발생할 수 있습니다.
이를 방지하기 위해 .gitignore 파일을 활용하는 것이 좋은데, 가끔 .gitignore가 예상대로 작동하지 않아 고민이 되는 경우가 있습니다.
이번 글에서는 .gitignore 파일이 무엇인지, 어떻게 작성하고 사용하는지, 그리고 작동하지 않을 때 해결하는 방법에 대해 알아보겠습니다.
1. .gitignore가 무엇인가?
.gitignore는 Git에서 특정 파일이나 폴더를 추적하지 않도록 설정하는 파일입니다.
개발 프로젝트에는 종종 코드 외에 환경 설정 파일, 로그 파일, 사용자별 설정 파일 등 다양한 데이터가 포함되는데, 이러한 파일들은 일반적으로 버전 관리에서 제외하는 것이 좋습니다.
예를 들어, 특정 개발 환경에 필요한 설정 파일이나 로그 파일을 무심코 커밋하게 되면 불필요한 파일들이 팀 프로젝트에 포함되어 혼란을 줄 수 있습니다.
.gitignore는 이를 방지해 주고, 버전 관리에서 꼭 필요한 파일만 깔끔하게 관리할 수 있도록 도와줍니다.
2. .gitignore 파일 작성 방법과 예시
.gitignore 파일은 프로젝트 루트 디렉터리에 위치하며, 각 줄에 무시하고자 하는 파일이나 폴더를 경로로 입력하면 됩니다.
기본적인 작성 규칙은 다음과 같습니다.
- 특정 파일 무시하기: example.txt와 같이 파일명을 직접 입력하면 해당 파일만 무시됩니다.
- 특정 폴더 무시하기: logs/처럼 폴더 이름 뒤에 슬래시(/)를 붙이면 해당 폴더와 그 내부의 모든 파일이 무시됩니다.
- 확장자로 무시하기: *.log와 같이 와일드카드(*)를 사용하면 특정 확장자를 가진 모든 파일을 무시할 수 있습니다.
- 예외 설정하기: !important.log처럼 앞에 느낌표(!)를 붙이면 무시 목록에서 제외되어 항상 추적됩니다.
다음은 실제 .gitignore 파일 예시입니다.
# 환경 설정 파일 무시하기
.env
# 로그 파일 무시하기
*.log
# 특정 폴더 무시하기
node_modules/
dist/
# 캐시 파일 무시하기
*.cache
# 중요 로그 파일은 추적 유지
!important.log
중간폴더 포함 그 하위 폴더를 제외 하려면(중요)
**/중간폴더/
최하위폴더를 제외 하려면(중요)
**/중간폴더/최하위폴더/
특정 폴더의 특정 확장자(log) 제외(중요)
/폴더명/*.log
특정 폴더를 포함 시킬 경우(중요)
!/폴더명예시 중에 제가 가장 중요하게 생각하는 것은 폴더 관련된 부분입니다.
폴더 관련 부분은 생각보다 자주 사용 하게 되는 것 같아요.
3. .gitignore가 작동하지 않을 때 해결 방법
.gitignore 파일이 제대로 작동하지 않을 때는 몇 가지 원인을 확인해야 합니다.
우선, .gitignore에 오타가 없는지, 정확한 경로를 입력했는지 점검하세요.
만약 이미 Git이 추적 중인 파일이라면 .gitignore에 추가해도 무시되지 않으므로, Git 캐시를 초기화해야 합니다.
이를 위해 다음 명령어를 실행해 보세요.
git rm -r --cached .
git add .
git commit -m "Update .gitignore"이 명령어는 기존에 추적 중인 파일을 캐시에서 제거하고, .gitignore에 정의된 설정에 따라 다시 파일을 무시하도록 만듭니 다.
4. 협업 프로젝트에서의 .gitignore 주의 사항
팀 프로젝트에서 .gitignore 파일을 설정할 때는 모든 팀원이 동일한 규칙을 사용하도록 하여, 불필요한 파일이 포함되지 않도록 주의해야 합니다.
개인 환경에서만 무시하고 싶은 파일이 있다면 .git/info/exclude 파일에 경로를 추가하여 로컬에서만 무시되도록 할 수도 있습니다.
.git/info/exclude는 커밋되지 않기 때문에 다른 팀원의 작업에는 영향을 미치지 않으므로 협업에 유용한 방법입니다.
5. .gitignore로 프로젝트 유지 관리하기
.gitignore는 코드와 불필요한 데이터를 구분하여 프로젝트를 깔끔하게 관리할 수 있게 해 줍니다.
이를 통해 코드 품질을 높이고, 협업 과정에서도 불필요한 충돌을 줄일 수 있습니다.
.gitignore 파일을 잘 활용하면 버전 관리가 더욱 효율적으로 이루어지고, 프로젝트 전반의 유지 보수가 쉬워집니다.
지금까지 .gitignore 사용법 및 작동하지 않을 때 처리 방법을 알아보았습니다.
감사합니다.
