안녕하세요.
Github PR을 생성할 때 템플릿을 설정할 수가 있더라구요?!!!
저처럼 몰랐던 분들을 위해서... 설정 방법에 대해서 소개해보려고 합니다.
템플릿을 사용하려면 우선 템플릿을 만들어야겠죠?
템플릿을 사용하는 방법은 크게 2가지로 나뉘어집니다.
- 단일 템플릿
- 멀티 템플릿
즉, 템플릿을 1개만 사용할 것이냐, 여러 개 사용할 것이냐 이죠.
사용 방법에 따라서 템플릿 파일 생성 규칙이 살짝 달라집니다.
## 1. 단일 템플릿 생성
root directory에 pull_request_template.md 파일을 만들거나
docs라는 directory에 pull_request_template.md 파일을 만들거나
(템플릿을 숨기고 싶은 경우) .github directory 안에 pull_request_template.md 파일을 만들어주세요.
여기에는 공통된 규칙이 있습니다.
모두 pull_request_template.md 라는 파일명을 쓴다는 것인데요,
만약 파일명이 다르다면, PR 생성 시 템플릿이 적용되지 않으니 주의해주세요!
## 2. 멀티 템플릿 생성
템플릿이 여러 개 필요한 경우가 있습니다.
이런 경우, .github/PULL_REQUEST_TEMPLATE directory 안에 템플릿 파일들을 넣어주시면 됩니다.
이렇게요!!ㅎㅎ
근데 이때도 주의할 점이 있어요.
템플릿 파일 이름 자체에는 제약이 없지만, 파일들은 꼭 .github/PULL_REQUEST_TEMPLATE 안에 있어야 해요!
## 3. PR 생성 시 템플릿 사용하기
템플릿을 만들었으니 이제 PR 생성을 해봐야겠죠?
단일 템플릿인 경우, PR 생성 시 자동으로 템플릿이 적용됩니다.
근데 멀티 템플릿인 경우는 자동으로 적용되지 않아요...ㅠㅠ
(default 템플릿이라도 설정할 수 있으면 좋을 텐데....)
멀티 템플릿의 경우, PR 생성했을 때의 URL 뒤에 &template={템플릿 파일 이름} 을 붙여줘야 합니다.
(ex. https://github.com/phillip5094/MyAwesomeRepo/compare/feature/branch1?expand=1&template=template1.md)
직접 보여드릴게요ㅎㅎ...
우선 처음 PR을 생성하면 이런 URL이 나오게 되는데,
URL 뒤에 &template=template1.md를 붙이면 멀티 템플릿 중 하나가 설정이 됩니다ㅎㅎ
😁 😁 😁
## 참고
Creating a pull request template for your repository - GitHub Docs
For more information, see "About issue and pull request templates." You can create a PULL_REQUEST_TEMPLATE/ subdirectory in any of the supported folders to contain multiple pull request templates, and use the template query parameter to specify the templat
docs.github.com
이번 글은 여기서 마무리.
'기타' 카테고리의 다른 글
내 터미널 설정 (0) | 2022.11.23 |
---|---|
Public Apple Framework들의 최소지원 버전을 볼 수 있는 사이트 (0) | 2022.06.18 |
앱의 모든 화면은 Scroll View로 구성해야 한다. (0) | 2022.03.29 |
Xcode Playground에서 Swift Package와 Assets 사용하는 방법 (0) | 2022.03.27 |
Mac 윈도우 창 캡처 방법 (0) | 2022.02.21 |