Bug 257854 – WPT export should not use the bug URL in the commit subject (title)

• Status: NEW
• Component: Tools / Tests

[Anne van Kesteren]

That's not great context for the upstream project.

[Radar WebKit Bug Importer]

<rdar://problem/110638179>

[youenn fablet]

Pull request: https://github.com/WebKit/WebKit/pull/14859

[Tim Nguyen (:ntim)]

*** Bug 270349 has been marked as a duplicate of this bug. ***

[Sam Sneddon [:gsnedders]]

From the dupe:

(In reply to Sam Sneddon [:gsnedders] from comment #0)
> Currently Chromium and Mozilla exports contain the full commit message, with
> some metadata. e.g.
> https://github.com/web-platform-tests/wpt/commit/
> 9aa0f67e426fac988de1625eb6c8926e225df602 (Chromium) or
> https://github.com/web-platform-tests/wpt/commit/
> 91dd2eb6f5a512dc4329a0d334e17a498c249f24 (Mozilla).
> 
> By comparison, our exporter produces a commit message like "WebKit export of
> https://bugs.webkit.org/show_bug.cgi?id=269971" or "Export made from a
> WebKit repository".
> 
> These are much less useful, and provide much less context for the change
> being made (especially in the latter case!).

Which is arguably broader in scope than just the summary line.

[Sam Sneddon [:gsnedders]]

I do wonder if this is better fixed by using `git-am` rather than `git-apply`; but we should almost certainly add more metadata (e.g., linking to where it was reviewed as is true for Chromium and Firefox).

That also then leaves the commit in a state where if there's a merge conflict you can run `git-am --continue` and get the right commit message and author etc.

[Sam Sneddon [:gsnedders]]

I'd suggest, based on our commit messages:

 * We move bugs away from the summary line (because "Limit the scope of invalidation traversal for :has(> .changed) .subject https://bugs.webkit.org/show_bug.cgi?id=297893 rdar://159173631" is a ridiculous summary line, when you fold whitespace) into `Bug` trailers
 * Rename our `Canonical Link` "trailer" to `WebKit-Canonical-Link`
 * Possibly add a `Reviewed-on: [PR]` trailer
 * Maybe move the "Reviewed by…" line to something more like Chromium's `Reviewed-by: [name] <[email]>` or Mozilla's `gecko-reviewers: [username]`, so that the start of the commit message is the actual content?
 * Maybe drop the changelog from the commit message?

Brianna's code to parse commit messages and extract sections would be helpful here…

[Tim Nguyen (:ntim)]

*** Bug 297925 has been marked as a duplicate of this bug. ***

[Sam Sneddon [:gsnedders]]

Currently, the title is a load-bearing part of how wpt-pr-bot detects WebKit exports, given it has to handle exports from arbitrary users (to mitigate the risk of a malicious actor getting review approved by claiming to be a WPT export): https://github.com/web-platform-tests/wpt-pr-bot/blob/3348953311e68835f1a2d03ca3384ee37b6fa199/lib/metadata/index.js#L113-L133

This needs to be changed prior to us landing any change here.