[meta] Enforce scoped Rust-GCC/gccrs#NNN
instead of unadorned #NNN
in Git commit logs
#3213
Labels
Rust-GCC/gccrs#NNN
instead of unadorned #NNN
in Git commit logs
#3213
I had wanted to bring this up for a long time, but... As is usually good practice (no question about that!), GCC/Rust Git commit logs sometimes use
#NNN
to refer to GitHub GCC/Rust Issue or Pull Request#NNN
. However, in upstream GCC,#NNN
have a very specific meaning: to refer to GCC Bugzilla#NNN
, so it's very confusing if GCC/Rust commits get upstreamed, where their Git commit logs contain#NNN
, which don't refer to GCC Bugzilla, but rather to GCC/Rust Issue or Pull Request#NNN
. That means, for example, that GCC/Rust commit logs'#NNN
s in several occasions got auto-linked to (totally unrelated!) upstream GCC bugs#NNN
.In context of the "Sourceware Forgejo experiment", @jwakely again raised this in https://inbox.sourceware.org/CAH6eHdTnB5Bqru=mZNzXmyu29D8PwCKj5Z1mbaAfA7rbrrDrYg@mail.gmail.com "Linking commits to PRs/MRs":
(I've added a few back-ticks to Jonathan's text, in order to stop auto-linking for those, here. ;-)
See https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls.
This checking would (preferrably) go into
.github/workflows/commit-format.yml
(right?), and/or be verified when upstreaming commits.It should highlight (or reject?) any unadorned
#N
,PRNNN
,PR COMPONENT/NNN
. (Have to check the exact patterns that GCC upstream considers to "own".) Probably is has to be "highlight" instead of generally "reject": there may be valid cases where GCC/Rust PRs contain Git commits with commit logs containing#NNN
, such as, when cherry-picking commits from GCC upstream.The text was updated successfully, but these errors were encountered: