GitHub拉取请求模板：获取当前分支名称

Question

我正在为我的代码库创建一个.Pull Request模板。

我按照https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/的说明添加了一个新文件，现在我希望它的正文包含使用当前分支名称（即pull request分支名称）生成的字符串。

在GitHub的文档中没有找到答案，想知道是否可能以及如何实现？

- Daniel Korn

Answer 1

我发了一条推文问：“有没有办法在 pull request 模板中获取当前分支名称？”

提到了 GitHub 帐户并获得了如下回答：

目前还没有这样的功能，但如果您想在所有 pull request 提交中包含此信息，您可以尝试使用 Probot：https://probot.github.io。我最近创建了https://github.com/probot/view-rendered，它会编辑 pull request 正文以添加已呈现链接。

推文链接: https://twitter.com/korndaniel1/status/1022468460226469888

- Daniel Korn

Answer 2

另一种实现方式是在 pre-commit hook 中更改模板文件。

#!/bin/sh
​
# Create git pull request template based on current branch
​
# Get current branch
branch=$(git branch --show-current)
​
# Check if template already contains current branch name
if grep -q $branch ./.github/PULL_REQUEST_TEMPLATE.md; then
    exit 0
fi
​
echo creating new pr template 
​
# Write text to the pr template file
cat > ./.github/PULL_REQUEST_TEMPLATE.md <<- EOM
##  Ticket Reference:
​
${branch}
EOM

- nico_dkd

---

我总是喜欢看到这样的答案，它说：“这是不可能的”，但是另一个答案却说：“这就是如何做到的。” 这展示了你的能力。 - lilHar

@lilHar 刚试了一下，实际上不能用。GitHub 使用来自“main”的拉取请求模板。 - Nils Guillermin

@NilsGuillermin，您是指文件夹中的“main”，还是分支中的“main”？ - lilHar

@lilHar 绝对是指主分支，如果你有一个旧项目，也可以称为“master”。 - Ronald

@NilsGuillermin，你还遇到这个问题吗？因为对我来说肯定是有效的。 - nico_dkd

@nico_dkd 有一个问题。如果在pre-commit钩子中更改了PULL_REQUEST_TEMPLATE文件，那么每次拉取请求都需要将此文件推入对应的分支，是这样吗？此外，当您发起拉取请求时，此更改文件尚未存在于代码库中，github会从当前代码库中存在的文件中提取内容。如果我漏掉了什么，请告诉我。 - Sujit