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.

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

Further group the changelog in subcategories using PR name prefixes or labels. #30538

Closed
priethor opened this issue Apr 6, 2021 · 3 comments
Closed
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time Needs Dev Ready for, and needs developer efforts [Type] Build Tooling Issues or PRs related to build tooling

Comments

@priethor
Copy link
Contributor

priethor commented Apr 6, 2021

What problem does this address?

Currently, the automatically generated changelog groups merged PRs depending on some of their labels (bug, enhancement, etc.), grouping unmatched PRs under a "Various" category that needs to be manually worked on when making a release. Moreover, in the final changelog, there is a second grouping level by functionality (Block Library, Global Styles, Customizer, etc.) under each main category, done manually, with the added difficulty that merged PRs sometimes don't have consistent enough naming to do so.

What is your proposed solution?

In preparation for the Gutenberg 10.4 RC, triage of the PRs that will ship with this release is underway, prefixing each of them with the corresponding subcategory (Block Library, Global Styles, etc.). This will allow the release manager to more easily group PRs. Ideally, the final changelog could take into account these new prefixes or other labels used. However, there are some hindrances:

  • Labels are not mutually exclusive, so nothing prevents a single PR from having contradictory labels (both as the main category and as a subcategory, e.g. pertaining to different blocks).
  • Subcategory prefixes should be defined and documented so that contributors know how to properly (re)name PRs.
  • Some subcategories currently have a special treatment, such as the "Navigation Editor and block": Navigation block PRs are not cataloged under "Block Library / Navigation" but under this special subcategory.
@priethor priethor added the [Type] Build Tooling Issues or PRs related to build tooling label Apr 6, 2021
@gziolo gziolo added Needs Dev Ready for, and needs developer efforts Good First Issue An issue that's suitable for someone looking to contribute for the first time labels Apr 8, 2021
@gziolo
Copy link
Member

gziolo commented Apr 8, 2021

Awesome ideas, thank you for opening this issue. It greatly aligns with the experience I had during my last plugin release.

Bonus points for sorting all entries in the section by the name like in https://make.wordpress.org/core/2021/04/02/whats-new-in-gutenberg-10-3-31-march/, examples:

Enhancements

  • Add since versions to the deprecated features. (30072)
  • Blocks: Add "theme" category and better present Template Parts in the inserter. (30020)
  • Block Editor:
    • Add drag handle to select mode. (28815)
    • Improve block inserter keyboard navigation. (26938)
    • Open admin sidebar menu over editor on small screens. (29955)
  • Block Library:
    • Cover: Allow drag and drop media replacement. (29813)
    • File: Make the editor markup match the frontend. (30148)
    • Social Links: Improve selected state of empty block. (29756)
    • Standardize the groups in the block toolbar. (30012, 29247, 29863)
    • Verse block: Add support for the padding to the verse block. (29820)

Bug Fixes

  • Block Library:
    • Cover: Improve disabled media buttons check for placeholder. (29858)
    • Embed:
      • Fix overzealous aspect ratio scaling for embeds. (29510)
      • Embed: Fix select on focus. (29431)
    • Gallery: Fix gallery item clicking. (29860)
    • Image:
      • Fix block reset sizes on external URL change. (26879)
      • Fix undo step with temporary URL. (30114)
    • Social Link: More accessible labels. (29659)
    • Video: Fix kind attribute missing subtitle value in video text track. (30040)

The file with the code that generates the changelog is in:

https://github.com/WordPress/gutenberg/blob/trunk/bin/plugin/commands/changelog.js

There are also some unit tests that should make the whole process more enjoyable:

https://github.com/WordPress/gutenberg/blob/trunk/bin/plugin/commands/test/changelog.js

@getdave
Copy link
Contributor

getdave commented Jul 6, 2021

It greatly aligns with the experience I had during my last plugin release.

Agreed. This also aligns with my experience. This would be a great upgrade.

@getdave
Copy link
Contributor

getdave commented Jul 30, 2021

I believe this has been addressed by #33229. I'm going to close out as suggested by @gziolo #33719 (comment).

@getdave getdave closed this as completed Jul 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue An issue that's suitable for someone looking to contribute for the first time Needs Dev Ready for, and needs developer efforts [Type] Build Tooling Issues or PRs related to build tooling
Projects
None yet
Development

No branches or pull requests

3 participants