[wp-trac] [WordPress Trac] #64595: Update Gutenberg ref in package.json

[WordPress Trac]

#64595: Update Gutenberg ref in package.json
----------------------------+---------------------
 Reporter:  ellatrix        |       Owner:  (none)
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  7.0
Component:  General         |     Version:  trunk
 Severity:  normal          |  Resolution:
 Keywords:  has-patch       |     Focuses:
----------------------------+---------------------

Comment (by desrosj):

 I've been thinking about the commit messages for these new hash bumps and
 I have some suggestions for improvement to make them more useful and
 informative.

 - Let's make sure to begin the short description with `Component:`
 prepended. This usually should match the component selected for the
 corresponding Trac ticket. I'm undecided on where these tickets fit best.
 General feels just OK, External Libraries and Editor feels wrong. Maybe
 Build/Test Tools? It is a tooling change after all. I'll give this one
 more thought.
 - For each commit, let's include the following as the first sentence in
 the message: "This updates the pinned commit hash of the Gutenberg
 repository from `OLD_FULL_HASH` to `NEW_FULL_HASH`.
 - Instead of listing the command that was run to generate the list (`git
 log --reverse --format. etc.`), let's instead include a link to the
 comparison view on GitHub. For example on [61750], that would be
 https://github.com/WordPress/gutenberg/compare/23b566c72e9c4a36219ef5d6e62890f05551f6cb...022d8dd3d461f91b15c1f0410649d3ebb027207f.
 This is more useful because someone can click it to view all of the
 commits, file diffs, etc. and follow various paths to dig deeper. The
 command that was run is important, but that's more of a detail for
 committers to be aware of that can be listed in the handbook. The previous
 suggestion also lists out the two hashes which makes it unnecessary. How
 about "A full list of changes included in this commit can be found on
 GitHub: `LINK`".
 - I don't think the link to the "CI run" or "Developed in is necessary for
 these. The pull requests now are essentially just a hash bump, so there's
 really no development that happens. The commit messages for the merges are
 really long (which is good), but I think this detail can be left out.
 - Let's move the list of changes above the "Props" and "See/Fixes". I
 think I can guess why you chose to put them above the list, but I believe
 that they are supposed to be at the end of the commit message. It's
 possible there is a parsing tool somewhere that is expecting that.
 - I came to this ticket because I was looking for information about which
 version of Gutenberg was included in the most recent bump prior to
 `7.0-beta2` but noticed that is not included in the messages. It would be
 really great to always pin hashes that correspond to tags, and thus
 releases. But I recognize this may not always be desired. It would still
 be nice to explain how the included changes line up to those tagged
 versions, especially since we reference them in the beta 1 post and a few
 locations in the user documentation. If it lines up directly, including
 the version number in parentheses next to the old and new hashes could
 work. Otherwise, a note like "This merges all changes that were cherry-
 picked to the `wp/7.0` branch between WordPress `7.0-beta1` and today
 (preparing for `7.0-beta2`).

 Once this is dialed in, let's add a message template for these merge
 commits to the Commit Messages [https://make.wordpress.org/core/handbook
 /best-practices/commit-messages/ Best Practices page] in the Core handbook
 once.

 Putting this all together, this is the template I think so far:


 {{{
 Component: Bump the pinned hash from the Gutenberg repository.

 (WITH versions aligning with tags)
 This updates the pinned commit hash of the Gutenberg repository from
 `%%OLD_FULL_HASH%%` (version `v25.0.0`) to `%%NEW_FULL_HASH%%` (version
 `26.0.0`).

 (Without versions aligning with tags)
 This updates the pinned commit hash of the Gutenberg repository from
 `%%OLD_FULL_HASH%%` to `%%NEW_FULL_HASH%%` and merges all of the changes
 that were cherry-picked to the `wp/7.0` branch between WordPress
 `7.0-beta1` and today (preparing for `7.0-beta2`).

 A full list of changes included in this commit can be found on GitHub:
 %%LINK%%.

 The following commits are included:
 - Pattern Editing: The best pattern feature yet!
 (https://github.com/WordPress/gutenberg/pull/#####)
 - Global Styles: Adding support for feature X within the block styles.
 (https://github.com/WordPress/gutenberg/pull/#####)
 - etc..

 Follow-up to [27195], [41062]. (optional)

 Reviewed by a-fellow-committer, maybe-multiple.
 Merges [26851] to the x.x branch. (both of these are only required when
 backporting from `trunk`)

 Props person, another.
 Fixes #30000. See #20202, #105.
 }}}

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/64595#comment:21>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform