[Git] .gitignore에 뭘 써야할 지 모르겠다면? - 자동 생성 도구를 써보세요!

.gitignore 이란?

github과 같은 git 온라인 저장소에 repository를 push할 때, 남들에게 공개할 수 없는 아주 중요한 데이터를 담고 있는 파일이나 폴더를 감추고 싶었던 적이 있지 않으신가요?

github에 업로드 시, 이런 파일이나 폴더를 제외하고 업로드 할 수 있게 도와주는 파일이 .gitignore 파일이랍니다!

.gitignore 파일은 아래와 같은 모습을 하고 있습니다👇🏻

개발하면서 별도로 커스텀하여 만든 파일이나 폴더를 숨기고 싶을 경우엔 직접 파일을 수정해서 추가해주면 되지만,

개발을 진행하다보면 단순히 한두개 정도만 숨기는 게 아니라 점점 숨기는 파일과 폴더가 많아지게 됩니다.

그리고 개발에 사용하는 언어, 프레임워크, 운영체제, 개발도구 등에 따라 일반적으로 숨기는 기본 파일과 폴더들이 존재합니다.

이런 것들을 따로 템플릿처럼 생성해두고 추가해둘 수 있으면 편하지 않을까요?

오늘은 이러한 작업을 대신 해주는 도구를 소개해드리려고 합니다!

Create useful .gitignore files for your project

www.toptal.com

gitignore.io는 운영체제, 개발환경(IDE), 개발 언어를 입력하면 그에 맞게 필요한 gitignore 파일을 생성해주는 웹사이트 입니다.

예를 들어, 다음과 같은 개발환경을 위한 gitignore 파일을 생성한다고 해보죠:

그럼 아래 사진과 같이 위 3가지 옵션을 동시에 만족하는 파일을 생성하도록 요청할 수 있습니다.

이렇게 3가지를 동시에 입력하고, 생성을 누르면 아래와 같이 gitignore 파일에 들어가야 하는 내용(text)을 생성해줍니다.

기존에 .gitignore 파일이 프로젝트에 있었다면, 위와 같이 생성된 텍스트를 전체 선택하고 .gitignore 파일에 붙여넣기 하면 됩니다.

GitHub에서도 .gitignore을 쉽게 작성할 수 있도록 샘플을 제공해주는 repository가 있습니다.

GitHub - github/gitignore: A collection of useful .gitignore templates

A collection of useful .gitignore templates. Contribute to github/gitignore development by creating an account on GitHub.

github.com

위와 같이 다양한 옵션의 파일들이 있으니, 여기서 검색해서 내용을 복사한 후, 붙여넣기 하셔도 됩니다!

만일 기존 프로젝트에 .gitignore 파일이 없었다면?

커맨드 또는 git bash에서 프로젝트의 루트 폴더(.git 폴더와 같은 위치)에 .gitignore 파일을 생성해주면 됩니다!

touch .gitignore

이렇게 생성된 파일에 gitignore.io에서 생성한 텍스트 또는 github에서 제공해준 텍스트를 복사 붙여넣기 해주시고, 커밋&푸시 해주시면 끝이랍니다!!

GitHub repository 페이지 내에서도 파일을 직접 추가하고 gitignore 파일을 설정할 수 있답니다!

위 사진과 같이 Add file을 누르고 Create new file을 선택해줍니다.

파일 생성 화면에서 파일명을 .gitignore로 설정하면 화면 우측에 Choose .gitignore: None 이라고 써있는 드롭다운 메뉴가 생깁니다.

이 드롭다운 메뉴를 선택하면 아래와 같은 메뉴가 뜨는데, 여기서 원하는 옵션을 검색해서 선택해주면 됩니다.

여기서 원하는 옵션을 선택하면 아래와 같이 선택된 옵션에 필요한 .gitignore 내용이 추가됩니다.

하지만, 이 방법에는 치명적인 단점이 있답니다...

옵션 중복 선택이 되지 않는다는 것입니다🥲

위와 같이 Android를 선택했다가 C를 선택하면 전체 내용이 C를 위한 .gitignore로 변경됩니다.

그렇기 때문에 이 방법은 비추합니다만, 한 가지만 필요한 소규모 1인 프로젝트를 진행할 시에는 간편하게 사용할 수도 있으니, 알아두시고 활용하시기 바랍니다 😊