.gitignore 파일 생성하기 (gitignore.io)

특정 파일에 공개되면 안되는 key 값 등이 저장되어있다면 이를 노출시키지 않는 것이 중요하다. 특히 Django를 이용해 새로운 프로젝트를 생성하면 secret key 값이 자동으로 생성되게 되는데, 이 키가 배포되어 공개되면 차후에 보안 문제가 발생할 수 있다. 또는 db 파일 같은 경우 협업하는 사용자별로 다른 데이터를 가진 db를 가지고 있을 수 있고, 이것 때문에 파일들이 충돌을 일으킬 수 있다.

이런 문제를 일으킬 수 있는 파일들을 github 등에 올리지 않도록 예외 처리를 해주어야 하는데 그것이 바로 .gitignore 파일이다.

이 gitignore 파일에 저장되어야 하는 파일들은 언어에 따라서(python 등), 언어로 어떤 작업을 하느냐에 따라서(django 등), 어떤 IDE로 작업하느냐에 따라서(vscode, pycharm 등) 필수 및 선택적으로 포함해야 하는 목록들이 달라진다.

이러한 gitignore 파일을 사용자가 매번 그 파일들을 확인하여 추가하는 것이 어렵기 때문에 이를 도와주는 사이트가 있다.

gitignore.io 가 바로 그것이다.

gitignore.io

링크를 통해 페이지에 접속하면 위와 같은 화면을 볼 수 있다.

가운데 있는 필드에 사용 언어, 사용 앱, 사용 IDE 등을 입력해주면 그에 맞게 .gitignore 파일을 띄워준다.

Python, Django, vscode 를 입력하고 생성해보았다.

위와 같은 화면을 시작으로 아래로 길게 많은 제외 목록들이 표시된다. django를 사용하면서 업로드 되면 충돌을 일으킬만한 db 파일, media 파일, pycache 파일 등이 git으로 업로드 되지 않도록 제외되어있는 것을 알 수 있다.

이 텍스트들을 위와 같이 git의 루트 디렉토리에 .gitignore 파일을 만들어 복사해주면 된다.

위 예시는 secret key 등이 저장되어 있는 secret.json 개인 생성 파일을 추가해준 모습이다.