GitHub 리포지토리 템플릿을 만들고 사용하는 방법

Introduction

Setup and use GitHub Repository Templates

Create a Repository

Change Folder

Add Files to Folder

Add Files to a Commit

Create a Commit

Push Commit to GitHub

Convert the Repository to a Template Repository

Create a Repository Using the Template Repository

Conclusion

소개

이 가이드에서는 추가 리포지토리를 만드는 데 사용할 수 있는 GitHub 템플릿 리포지토리를 만들고 사용하는 방법을 설명합니다.

템플릿 리포지토리를 사용하는 주된 이유는 일반적으로 사용하는 모든 파일을 템플릿 리포지토리에 추가하여 새 리포지토리를 생성해야 할 때마다 파일을 추가할 필요가 없기 때문입니다. 이러한 파일은 사용자 지정 .gitignore 파일처럼 간단할 수 있으며 애플리케이션에 사용하는 미리 정의된 템플릿까지 가능합니다.

GitHub 리포지토리 템플릿 설정 및 사용

시작하기 전에 GitHub 및 git CLI 도구가 설치되어 있고 두 도구를 사용하여 GitHub 계정을 인증했는지 확인하십시오.

참고: 아래 예에서 사용된 템플릿 리포지토리 이름인 my-template-repo는 원하는 대로 변경할 수 있습니다.

리포지토리 만들기

먼저 CLI 도구를 열고 일반 GitHub 리포지토리(공개 또는 비공개 리포지토리)를 만듭니다.

gh repo create my-template-repo \
            --private \
            --clone \
            --gitignore Python \
            --disable-wiki \
            --license MIT

그렇다면 위의 기능은 무엇입니까? 그것은:

my-template-repo라는 리포지토리를 만듭니다.

개인 리포지토리가 됩니다(--private(공개하려면 --public으로 변경)).

현재 있는 폴더에 복제됩니다(--clone).

.gitignore 파일은 Python용 GitHub의 기본값(--gitignore Python)으로 생성됩니다. 기타는 다른 언어로 사용할 수 있습니다.

저장소의 wiki 섹션이 비활성화됩니다(--disable-wiki).

MIT 라이선스가 적용됩니다(--license MIT). 다른 것을 사용할 수 있습니다. 또는 리포지토리에 라이선스를 적용하지 않으려면 이를 제거할 수 있습니다.

폴더 변경

일반적으로 리포지토리의 이름인 리포지토리가 복제된 폴더로 이동합니다.

cd my-template-repo

폴더에 파일 추가

원하는 모든 파일을 폴더에 넣고 원하는 .gitignore 파일을 변경합니다.

커밋에 파일 추가

커밋할 파일을 추가합니다.

git add .

커밋 만들기

추가되거나 변경된 모든 파일에 대한 커밋을 만듭니다.

git commit -m "Base template files"

GitHub에 커밋 푸시

파일을 해당 리포지토리로 푸시합니다.

git push

리포지토리를 템플릿 리포지토리로 변환

리포지토리를 템플릿 리포지토리로 변환합니다.

gh repo edit <your-github-username>/my-template-repo --template

웹 브라우저에서 리포지토리 목록을 보면 이제 리포지토리 이름 옆에 비공개가 아닌 비공개 템플릿으로 표시됩니다.

템플릿 리포지토리를 사용하여 리포지토리 생성

이제 해당 템플릿에서 새 리포지토리를 만들 수 있습니다. my-new-repo를 원하는 이름으로 변경하고 개인 리포지토리가 필요한 경우 --public을 --private로 변경합니다.

gh repo create my-new-repo \
            --public \
            --clone \
            --template my-template-repo

리포지토리는 현재 있는 폴더의 새 리포지토리 이름을 가진 폴더에 복제됩니다.

결론

이 문서에서는 다음을 다루었습니다.

템플릿으로 사용할 새 저장소를 만듭니다.

파일이 추가된 후 해당 리포지토리를 템플릿으로 변환합니다.

마지막으로 해당 템플릿 저장소에서 새 저장소를 배포합니다.