GitHub - 새로운 리파지토리에 C# 프로젝트 파일 .gitignore 추가하기

개요

깃허브에 씨샵 윈폼 관련 프로젝트를 올리려고 새로운 리포지토리를 만들려 했는데,
깃이그노어에 씨샵 관련 언어가 보이지 않는다.


이야기에 앞서 .gitignore 파일에 대해 알아보자

.gitignore 파일이란?

깃 리포지토리를 이용하여 관리할 때 불필요한 파일이나 디렉토리를 제외하기 위해 사용하는 파일이다.
이 파일을 이용하여 특정 경로의 파일들의 커밋 푸쉬 제외할 수 있다.
깃 이그노어 파일은 사용자 및 개발 환경에 따라서도 다소 다를 수 있기 때문에
일반적으로 특정 프로젝트의 종류나 개발 언어에 따라 설정해두고 요구에 맞게 필요한 설정을 추가한다.


.gitignore 파일을 설정하는 이유는?

[ 불필요한 파일을 추려 경량화 및 속도 향상 ]

  • 프로젝트 생성 및 빌드 중에 생성되는 임시 파일, 빌드 결과물 등의 파일을 제외함으로써 리파지토리를 더 경량화 하고 작업 속도를 향상 시킬 수 있다.
  • 또한 깃허브에서는 푸쉬(업로드)하는 파일의 용량이 100메가보다 클 경우 업로드가 되지 않기 때문에 불필요한 파일을 제외하고 필요한 프로젝트만 파일을 올리는 것이 좋다.

[ 보안 및 개인 정보 보호 ]

  • 리파지토리가 공개일 경우, 프로젝트 내에 포함된 민감한 정보를 포함한 파일(API키, 토큰, DB 접속 정보 등)이 리파지토리에 저장될 수 있다.
  • 별 다른 설정 없이 깃 리파지토리에 프로젝트 파일을 올려서 API 키가 노출 되어 과금되는 등의 위험을 초래 할 수 있다. (실제로 주위에서 AWS 접속 정보가 노출되어 30만원 과금된 사람이 있었다.) 이러한 중요한 정보가 담긴 파일을 제외하여 보안을 강화할 수 있다.

C# 프로젝트를 .gitignore에 추가하려면?

C# 프로젝트는 대개 비주얼 스튜디오(Visual Studio)에서 작업을 한다.
그렇기 때문에 프로젝트 파일은 Visual Studio에서 생성되는 파일과 디렉토리의 형식이 비슷하기 때문에
'VisualStudio'를 템플릿을 추가하면 된다.


참고