gitignore가 필요한 상황
프로젝트를 진행하고 있다. Github에 올릴 때 token_channelid.txt 파일은 빼고 올릴 수 없을까?
물론 git add 로 파일을 하나하나 지정해서 올릴 파일을 설정할 수 있지만 파일이 10000개라면 일일이 지정하기 번거로울 것이다. 그리고 협업을 하다 보면 git add . 명령어로 실수로 올리는 것을 방지하고 싶다.
이런 경우 .gitignore 을 사용하면 된다. .gitignore을 이용하면 원하는 파일을 github에 올라가지 않도록 설정할 수 있다.
- 프로젝트 초기 세팅
- API KEY처럼 github에는 보여지면 안되는 것들
.gitignore 설정 방법
1. 프로젝트의 최상위 경로에 .gitignore 파일을 하나 만든다.
2. .gitignore 파일 작성
문법 | 문법 설명 | 사용 예시 |
* | /을 제외한 모든 문자열과 매칭 | *.py # 확장자가 .py 인 모든 파일은 무시 |
! | !에 들어간 것은 무시하지 않음 | !test.py # .py인 파일들은 모두 무시되지만, test.py는 무시하지 않음. |
/ | 해당 경로의 위치에 있는 것만 무시함. | /test.py # 경로가 /test.py 인 것만 무시함. node_modules/ # node_modules에 있는 모든 파일을 무시함. |
** | 특정 디렉토리 하위에 있는 모든 파일을 무시함. | src/**/*.txt # src 하위에 있는 모든 .txt 파일을 무시함. |
하지만 문법을 모두 외우기는 쉽지 않다.
이런 문법을 몰라도 할 수 있는 방법이 크게 2가지가 있다.
- chatGPT 활용
아래와 같이 프롬프트를 치면 된다.
.gitignore 파일을 작성하려고 해.
무시해야 할 파일은 다음과 같아.
C:\kakao_school_notice_reminder\token_channelid.txt
C:\kakao_school_notice_reminder\_template
그럼 GPT가 아래와 같이 알려준다. 해당 코드를 복사해서 .gitignore 파일에 적용한다.
- https://www.gitignore.io/ 사이트 활용
해당 사이트에서 원하는 gitignore 파일을 간단하게 생성할 수 있다.
3. push 후 github 레파지토리에 잘 적용 되었는지 확인
정상적으로 _template 파일과 token_channelid.txt 파일은 올라가지 않은 것을 확인할 수 있다.