Incorrect issue references due to GitHub default merge messages

[reddevilmidzy]

When syncing subtree repositories via josh-sync, the default GitHub merge commit message is preserved:

Merge pull request #xxx from owner/branch

As a result, #xxx is resolved against rust-lang/rust instead of the original subtree repository, leading to incorrect issue references.

I'm not sure if this has been discussed before, but rewriting merge commit messages during sync to use:

rust-lang/{subtree-repo}#xxx

would allow references to point to the correct issues.

---

cc: rust-lang/rust#154980

The commits here refer to the rustc-dev-guide issue, not the rust issue.

[Kobzol]

Yeah similar problem has been discussed many times =D I'm not sure if we can rewrite the commits so easily though, it would have to be done in both repos I suppose, so that the SHAs match.

[tgross35]

Could we poke GH for a way to customize the merge message template perhaps? Then we could add a rust-lang/whatever# prefix at least.

Squash merging does have the same issue with the default message where it adds (#1234) but at least you can change it before merge, though that's something you have to do every time. (I do this manually in compiler-builtins when squashing specifically because of this issue, but usually rebase to avoid it entirely.)

[reddevilmidzy]

Ah, even though I change the merge commit message to rust-lang/#xxx, the GH UI hides it and only shows the issue number.

Since doing it manually can often lead to forgetting or making typos, it might be a good idea to create and use a plugin as a temporary measure.

[Kobzol]

I don't think that it is possible to override the commit message template on GitHub at the moment.

[reddevilmidzy]

I created a plugin that automatically adds <owner>/<repo_name> to the commit message when merging!

https://addons.mozilla.org/en-US/firefox/addon/gh-pr-msg-rewriter/

#general > Plugin: fix josh-sync merge commit references