.gitignore는 Git에서 특정 파일이나 디렉토리를 추적하지 않도록 설정하는 파일입니다. GitHub에서 .gitignore를 사용하면 민감한 정보(예: API 키, 암호, 환경 파일 등)나 불필요한 파일(예: 로그, 빌드 파일)을 리포지토리에 추가하지 않도록 관리할 수 있습니다.

아래는 .gitignore의 사용법을 단계별로 설명한 가이드입니다.

.gitignore 파일 생성
프로젝트 루트 디렉토리에 .gitignore 파일을 생성합니다.

touch .gitignore

원하는 텍스트 편집기(예: VS Code, nano)로 .gitignore 파일을 엽니다.

.gitignore 파일에 규칙 작성

.gitignore 파일에는 Git이 무시할 파일/디렉토리를 정의합니다.

2.1. 기본 규칙

파일 이름:

secrets.key # 특정 파일 무시

디렉토리:

/logs/ # logs 디렉토리 전체 무시

확장자:

.log # 모든 .log 파일 무시 .key # 모든 .key 파일 무시

2.2. 예외 규칙

특정 파일은 무시하지 않으려면 !로 시작합니다.

*.env # 모든 .env 파일 무시 !example.env # example.env 파일은 예외로 포함

2.3. 예시

환경 설정 파일

.env *.key

빌드 출력

/build/ dist/

로그 파일

*.log logs/

운영 체제별 파일

.DS_Store Thumbs.db

Python 가상환경

venv/ pycache/ *.pyc

.gitignore 적용 방법
.gitignore 파일을 저장한 후 Git이 무시하도록 설정합니다.
이미 Git에 추적 중인 파일은 .gitignore에 추가해도 바로 무시되지 않습니다. 아래 명령어로 캐시에서 제거해야 합니다:

git rm --cached <파일 또는 디렉토리 경로>

예:

git rm --cached secrets.key git rm -r --cached /logs/

변경 사항을 커밋합니다:

git add .gitignore git commit -m "Add .gitignore"

GitHub에서 .gitignore 템플릿 사용

GitHub에서는 각 프로그래밍 언어 및 프레임워크에 맞는 .gitignore 템플릿을 제공합니다.

.gitignore 생성 시 GitHub 템플릿 선택:

새 리포지토리 생성 화면에서 "Add .gitignore"를 클릭하고 언어를 선택합니다.

GitHub의 .gitignore 템플릿 저장소에서 직접 다운로드:

예: Python 템플릿

Byte-compiled / optimized / DLL files

pycache/ .py[cod] $py.class

Virtual environments

venv/

GitHub에 .gitignore 적용

.gitignore를 설정하면 다음과 같은 파일은 리포지토리에 업로드되지 않습니다:

.env

*.key

/build/ 등

확인 방법:

git status 명령어로 무시된 파일이 표시되지 않는지 확인합니다.
무시되길 원하지 않는 파일은 .gitignore에서 예외 처리합니다.

참고

.gitignore를 설정해도 이미 Git에 추가된 파일은 무시되지 않습니다.

이를 해결하려면 캐시에서 제거 후 다시 추가해야 합니다.

중요한 민감 정보(API 키, 비밀번호)는 반드시 .gitignore에 추가하고, 절대 GitHub에 업로드하지 마세요.

Junghyun99 / Test

gitignore 사용법 #20