Шаблон Github Pull Requests не отображается

Question

Я хотел создать собственный шаблон Pull Requests для моего репозитория Github (внутренняя версия в моей компании, а не на Github.com), поэтому я следовал инструкциям по этой ссылке. Я следовал ниже шагов:

1. Создан новый файл шаблона в папке: [my-repo]/. Github/PULL_REQUEST_TEMPLATE/pull_request_template.md.
2. Слил этот новый файл в мастер.
3. Создал новую ветку от мастера, передал некоторые изменения в новую ветку.
4. Создан новый запрос на извлечение для мастера, но шаблон не появился.

Создание нового PR не показывало шаблон, который я создал. Подобные шаги для создания новых шаблонов вопросов работают нормально, но шаблоны PR не работают. Я хотел бы добавить различные шаблоны в папку PULL_REQUEST_TEMPLATE, чтобы создать несколько шаблонов запросов на извлечение, таких как шаблон функций, шаблон исправления ошибок и т. Д. В моей разметке шаблона PR есть следующее:

---
name: Design Review
about: Design Review issue template

---

# PR Change Description
This PR is to add a new vendor type.

Answer 1

Вы должны создать шаблоны в ветке хранилища по умолчанию. Шаблоны, созданные в других ветвях, недоступны для использования соавторами. Вы можете сохранить шаблон запроса извлечения в видимом корневом каталоге хранилища, в папке docs или в скрытом каталоге.github. Имена файлов шаблона запроса извлечения не чувствительны к регистру и могут иметь расширение, например.md или.txt.

Answer 2

GitHub по умолчанию загрузит файл .github/PULL_REQUEST_TEMPLATE.md как шаблон PR.

Однако можно иметь несколько шаблонов и ссылаться на них, используя строку запроса на URL-адресе, например:https://github.com/octo-org/octo-repo/compare/master...pull-request-test?template=pr_template.md

Это загрузит шаблон pr_template.md из .github/PULL_REQUEST_TEMPLATE/pr_template.md, где master это ветвь назначения и pull-request-test это ветка для слияния.

Аналогично для вопросов

https://github.com/octo-org/octo-repo/issues/new?template=issue_template.md

Документы на этот счет написаны не очень хорошо, однако полный набор параметров для формы создания PR указан здесь: https://help.github.com/en/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters, но он даже имеет неправильный URL-адрес для этого конкретного примера

Для проблем теперь есть селектор для шаблонов, настроенных с помощью yaml, поэтому вы можете выбирать между шаблонами без использования строк запроса, возможно, что-то подобное появится позже для PRhttps://help.github.com/en/github/building-a-strong -сообщество / настройка-шаблоны-проблемы-для-вашего-репозитория

Answer 3

Я попробовал добавить свой pull_request_template.md файл в .github/PULL_REQUEST_TEMPLATE/pull_request_template.md путь

но это не сработало, я переместил свой файл в .github/pull_request_template.md путь т.е. удален подкаталог PULL_REQUEST_TEMPLATE и бум это сработало.

Поэтому, если у вас нет нескольких шаблонов, вам не нужно создавать PULL_REQUEST_TEMPLATE подкаталог и убедитесь, что вы создали свой pull_request_template.md в вашей ветке по умолчанию, которая в основном master.

Answer 4

Вы должны только создать файл внутри .github папка, а не PULL_REQUEST_TEMPLATE папка.

Перемещение вашего .md подать в .github/PULL_REQUEST_TEMPLATE.md должно сработать.

Answer 5

В моем случае имя файла было .github/pull_request_template.mdкак описано в документах GitHub , и это не сработало, пока я не переименовал его в .github/PULL_REQUEST_TEMPLATE.md.

PS Я перемещал файл по разным папкам до этого изменения, так что может быть что-то застряло в кеше GitHub или около того.

Answer 6

Вы можете проверить, действительно ли файл находится в вашем каталоге. В моем случае vscode «визуально рухнул», поэтому я случайно создал файл в \.github\workflows.

Переместил его в каталог, чтобы он действительно был в \.githubи теперь он отображается, как и ожидалось. Это может быть очевидно, но мне потребовалось около 10 минут, чтобы заметить.