Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Commented-out pull-request template ends up in commit messages for merges #10264

Closed
joshtriplett opened this issue Jan 6, 2022 · 7 comments
Closed

Commented-out pull-request template ends up in commit messages for merges #10264

joshtriplett opened this issue Jan 6, 2022 · 7 comments
Labels
T-cargo Team: Cargo

Comments

@joshtriplett
Copy link
Member

Now that we have a PR template, submitting a pull request (either via the web form or via gh pr create) will commonly end up with a commented-out version of the pull request template in the message. This doesn't get rendered in the GitHub web UI, but when bors does a merge, it includes the entire PR template in the commit message for the merge. See dc6d847 for instance.
@joshtriplett joshtriplett added I-nominated-to-discuss To be discussed during issue triage on the next Cargo team meeting T-cargo Team: Cargo labels Jan 6, 2022
@weihanglo
Copy link
Member

That's not good 😞
Just curious. Does #10258 contain that PR template in it's description body?

@joshtriplett
Copy link
Member Author

@weihanglo Yes, it does, within HTML comments.

@alexcrichton
Copy link
Member

Oh I think this is a bors-ism, I believe GitHub strips out the comment when you hit the merge button. Alas though :(

@Mark-Simulacrum
Copy link
Member

There's already some similar-looking support in bors for cutting text from PR bodies (https://github.com/rust-lang/homu/blob/cf0674989a2b8be2c6c86e344f5cf1cb9320d049/homu/main.py#L46-L50) -- maybe possible to either use that syntax or a fairly easy patch to add some more human-readable header there.

@joshtriplett
Copy link
Member Author

@Mark-Simulacrum Ah, that looks like it should work. I'll send in a PR adding that to the PR template.

@joshtriplett
Copy link
Member Author

#10267

@joshtriplett joshtriplett mentioned this issue Jan 6, 2022
Merged
@weihanglo
Copy link
Member

I believe this is resolved by #10267. Closing.

@weihanglo weihanglo removed the I-nominated-to-discuss To be discussed during issue triage on the next Cargo team meeting label Oct 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-cargo Team: Cargo
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@alexcrichton @joshtriplett @Mark-Simulacrum @weihanglo