Add changelog from WordPress to tag/release

Question

Add changelog from WordPress to tag/release

chrillep opened this issue a year ago · comments

Christian Widlund commented a year ago

Summary

would be nice to get the changelog attached. Easier when using dependabot/renovate, so you can see what changed there.

Additional context

No response

Léo Colombaro · Answer 1 · Sun Jun 11 2023 04:20:17 GMT+0800 (China Standard Time)

Thanks for this suggestion, @chrillep!
It is a great idea, and that makes perfect sense.
That being said, WordPress does not seem to provide an API or an easy-to-use tool to retrieve the changelog.
But if you have that said API/tool, I'd love to use it, please make me wrong! 🙂

These are the constraints for feasibility:

Systematic availability for any new WordPress tag
Content endpoint/URL can be retrieved in a deterministic way for a given tag (e.g., without the jazzy-name in the endpoint)
Available at the time of the tag public availability
HTML scrapping is not an option

Christian Widlund · Answer 2 · Sun Jun 11 2023 15:16:35 GMT+0800 (China Standard Time)

Thanks for this suggestion, @chrillep! It is a great idea, and that makes perfect sense. That being said, WordPress does not seem to provide an API or an easy-to-use tool to retrieve the changelog. But if you have that said API/tool, I'd love to use it, please make me wrong! 🙂

These are the constraints for feasibility:

Systematic availability for any new WordPress tag

Content endpoint/URL can be retrieved in a deterministic way for a given tag (e.g., without the jazzy-name in the endpoint)

Available at the time of the tag public availability

HTML scrapping is not an option

i have no idea how it works :) . i just no what i want :) . but i can look in to it.

Top of mind wordpress repo.
https://github.com/WordPress/WordPress/tags
contains the revision id to look for
use that in
https://core.trac.wordpress.org/log/

scroll down to Download in other formats:
RSS Feed ChangeLog

i guess you can config params via at top with revision ids

6.2.1 compared to 6.2.2

i dont know svn and trac at all. But you could at least look into it. It looks promising :)

Léo Colombaro · Answer 3 · Sun Jun 11 2023 22:26:24 GMT+0800 (China Standard Time)

Interesting, thanks for these links. 👍
Using your example, that would lead to this below changelog between 2 minor versions.
Is it readable? Would you actually read it? Does it provide actually useful information?

For me, it's sadly a no-no-no. And this is quite painful as there is no way to use info from that.
Right?

Changelog 6.2.1 to 6.2.2

Sat, 20 May 2023 04:27:48 GMT desrosj [55838]

tags/6.2.2 (copied)

Tag 6.2.2

Sat, 20 May 2023 04:25:55 GMT desrosj [55837]

branches/6.2/src/wp-includes/version.php (modified)

WordPress 6.2.2 (for real).

The $wp_version number was previously incorrect.

Sat, 20 May 2023 04:12:29 GMT desrosj [55836]

branches/5.9/package-lock.json (modified)

branches/5.9/package.json (modified)

branches/5.9/src/wp-admin/about.php (modified)

branches/5.9/src/wp-includes/version.php (modified)

WordPress 5.9.7.

Sat, 20 May 2023 04:11:59 GMT desrosj [55835]

branches/6.0/package-lock.json (modified)

branches/6.0/package.json (modified)

branches/6.0/src/wp-admin/about.php (modified)

branches/6.0/src/wp-includes/version.php (modified)

WordPress 6.0.5.

Sat, 20 May 2023 04:11:32 GMT desrosj [55834]

branches/6.1/package-lock.json (modified)

branches/6.1/package.json (modified)

branches/6.1/src/wp-admin/about.php (modified)

branches/6.1/src/wp-includes/version.php (modified)

WordPress 6.1.3.

Sat, 20 May 2023 04:11:14 GMT desrosj [55833]

branches/6.2/package-lock.json (modified)

branches/6.2/package.json (modified)

branches/6.2/src/wp-admin/about.php (modified)

branches/6.2/src/wp-includes/version.php (modified)

WordPress 6.2.2.

Sat, 20 May 2023 04:03:23 GMT desrosj [55832]

branches/5.9 (modified)

branches/5.9/package-lock.json (modified)

branches/5.9/package.json (modified)

branches/5.9/src/wp-includes/block-template.php (modified)

branches/5.9/src/wp-includes/blocks/template-part.php (modified)

Editor: Restore shortcode support for block templates.

Follow up to [55761].

Props youknowriad, Clorith, desrosj, antpb, Otto42, johnbillion,
jorbin, rmccue, timothyblynjacobs, mikeschroder, peterwilsoncc,
audrasjb, matveb, noisysocks, xknown, ehtis, isabel_brison,
talldanwp, gziolo, chriscct7, davidbaumwald.
Merges [55828] to the 5.9 branch.
See #58333.

Sat, 20 May 2023 04:02:53 GMT desrosj [55831]

branches/6.0 (modified)

branches/6.0/package-lock.json (modified)

branches/6.0/package.json (modified)

branches/6.0/src/wp-includes/block-template.php (modified)

branches/6.0/src/wp-includes/blocks/template-part.php (modified)

Editor: Restore shortcode support for block templates.

Follow up to [55761].

Props youknowriad, Clorith, desrosj, antpb, Otto42, johnbillion,
jorbin, rmccue, timothyblynjacobs, mikeschroder, peterwilsoncc,
audrasjb, matveb, noisysocks, xknown, ehtis, isabel_brison,
talldanwp, gziolo, chriscct7, davidbaumwald.
Merges [55828] to the 6.0 branch.
See #58333.

Sat, 20 May 2023 04:02:09 GMT desrosj [55830]

branches/6.1 (modified)

branches/6.1/package-lock.json (modified)

branches/6.1/package.json (modified)

branches/6.1/src/wp-includes/block-template.php (modified)

branches/6.1/src/wp-includes/blocks/post-featured-image.php (modified)

branches/6.1/src/wp-includes/blocks/template-part.php (modified)

Editor: Restore shortcode support for block templates.

Follow up to [55761].

Props youknowriad, Clorith, desrosj, antpb, Otto42, johnbillion,
jorbin, rmccue, timothyblynjacobs, mikeschroder, peterwilsoncc,
audrasjb, matveb, noisysocks, xknown, ehtis, isabel_brison,
talldanwp, gziolo, chriscct7, davidbaumwald.
Merges [55828] to the 6.1 branch.
See #58333.

Sat, 20 May 2023 04:01:19 GMT desrosj [55829]

branches/6.2 (modified)

branches/6.2/package-lock.json (modified)

branches/6.2/package.json (modified)

branches/6.2/src/wp-includes/block-template.php (modified)

branches/6.2/src/wp-includes/blocks/template-part.php (modified)

Editor: Restore shortcode support for block templates.

Follow up to [55761].

Props youknowriad, Clorith, desrosj, antpb, Otto42, johnbillion,
jorbin, rmccue, timothyblynjacobs, mikeschroder, peterwilsoncc,
audrasjb, matveb, noisysocks, xknown, ehtis, isabel_brison,
talldanwp, gziolo, chriscct7, davidbaumwald.
Merges [55828] to the 6.2 branch.
See #58333.

Sat, 20 May 2023 03:56:54 GMT desrosj [55828]

trunk/package-lock.json (modified)

trunk/package.json (modified)

trunk/src/wp-includes/block-template.php (modified)

trunk/src/wp-includes/blocks/template-part.php (modified)

Editor: Restore shortcode support for block templates.

Follow up to [55761].

Props youknowriad, Clorith, desrosj, antpb, Otto42, johnbillion,
jorbin, rmccue, timothyblynjacobs, mikeschroder, peterwilsoncc,
audrasjb, matveb, noisysocks, xknown, ehtis, isabel_brison,
talldanwp, gziolo, chriscct7, davidbaumwald.
Fixes #58333.

Fri, 19 May 2023 13:25:49 GMT SergeyBiryukov [55827]

trunk/src/wp-admin/includes/class-pclzip.php (modified)

trunk/src/wp-admin/includes/file.php (modified)

trunk/src/wp-includes/class-wp-http-cookie.php (modified)

trunk/src/wp-includes/class-wp-http.php (modified)

trunk/src/wp-includes/class-wp-oembed.php (modified)

trunk/src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php (modified)

trunk/src/wp-includes/media-template.php (modified)

trunk/src/wp-includes/media.php (modified)

trunk/src/wp-includes/option.php (modified)

Docs: Fix a few more typos in DocBlocks and inline comments.

Follow-up to [6779], [10565], [12023], [25224], [27533], [32806],
[34777], [45262], [46594], [55823], [55824].

Props Presskopp.
See #57840.

Fri, 19 May 2023 12:44:54 GMT spacedmonkey [55826]

trunk/src/wp-includes/meta.php (modified)

trunk/src/wp-settings.php (modified)

Networks and Sites: Load WP_Metadata_Lazyloader class file if class
in meta.php.

In [55818] did a check to see if WP_Metadata_Lazyloader class
existed and the loaded in the class file if it did not. However,
require in wp-settings.php was not removed and resulted in the class
being loaded twice. To be safe, only include the class file in
meta.php and remove from wp-settings.php file.

Props spacedmonkey, ryelle.
See #58185.

Thu, 18 May 2023 19:53:37 GMT flixos90 [55825]

trunk/src/wp-includes/media.php (modified)

trunk/tests/phpunit/tests/media.php (modified)

Media: Prevent special images within post content to skew image
counts and cause lazy-loading bugs.

In order to skip lazy-loading the first few images on a page, as of
WordPress 5.9 there has been logic to count images that are eligible
based on certain criteria. One of those groups are images that appear
within the content of a post.

This changeset fixes a bug where images created via
get_the_post_thumbnail() or wp_get_attachment_image() that are
injected into the post content would skew the count and therefore
result in all images to be lazy-loaded, potentially hurting load time
performance. This is relevant for example when those functions are
called in server-side rendered blocks, or any other filter callbacks
hooked into the_content.

Props flixos90, antpb, joedolson, spacedmonkey, mukesh27, thekt12,
costdev, jrf.
Fixes #58089.
See #53675.

Thu, 18 May 2023 12:34:22 GMT SergeyBiryukov [55824]

trunk/src/wp-admin/includes/class-plugin-upgrader.php (modified)

trunk/src/wp-admin/includes/class-theme-upgrader.php (modified)

trunk/src/wp-admin/includes/class-wp-filesystem-base.php (modified)

trunk/src/wp-admin/includes/update-core.php (modified)

trunk/src/wp-admin/update-core.php (modified)

Docs: Fix a few more typos in inline comments.

Follow-up to [9117], [11005], [12097], [18632], [26192], [55823].

Props Presskopp.
See #58334, #57840.

Thu, 18 May 2023 11:35:21 GMT SergeyBiryukov [55823]

trunk/src/wp-admin/includes/class-bulk-upgrader-skin.php (modified)

Docs: Fix typo in a comment in Bulk_Upgrader_Skin::header() and
::footer().

Follow-up to [13602].

Props kamplugins, costdev, mukesh27, afragen.
Fixes #58334.

Wed, 17 May 2023 22:44:21 GMT westonruter [55822]

trunk/src/wp-admin/includes/file.php (modified)

trunk/src/wp-includes/blocks.php (modified)

trunk/src/wp-includes/class-wp-query.php (modified)

trunk/src/wp-includes/kses.php (modified)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php (modified)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php (modified)

trunk/src/wp-includes/script-loader.php (modified)

trunk/tests/performance/wp-content/mu-plugins/server-timing.php (modified)

trunk/tests/phpunit/tests/admin/wpSiteHealth.php (modified)

trunk/tests/phpunit/tests/blocks/editor.php (modified)

trunk/tests/phpunit/tests/blocks/renderCommentTemplate.php (modified)

trunk/tests/phpunit/tests/blocks/wpBlock.php (modified)

trunk/tests/phpunit/tests/dependencies/scripts.php (modified)

trunk/tests/phpunit/tests/general/wpPreloadResources.php (modified)

trunk/tests/phpunit/tests/kses.php (modified)

trunk/tests/phpunit/tests/media.php (modified)

trunk/tests/phpunit/tests/pluggable/wpMail.php (modified)

trunk/tests/phpunit/tests/query/stickies.php (modified)

trunk/tests/phpunit/tests/rest-api/rest-server.php (modified)

trunk/tests/phpunit/tests/rest-api/rest-themes-controller.php (modified)

trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php (modified)

General: Use static on closures whenever $this is not used to
avoid memory leaks.

Props westonruter, jrf, spacedmonkey.
Fixes #58323.

Wed, 17 May 2023 18:29:41 GMT flixos90 [55821]

trunk/src/wp-includes/default-filters.php (modified)

trunk/src/wp-includes/media.php (modified)

trunk/src/wp-includes/post-thumbnail-template.php (modified)

trunk/tests/phpunit/tests/media.php (modified)

trunk/tests/phpunit/tests/post/thumbnails.php (modified)

Media: Introduce wp_get_attachment_image_context filter.

Since WordPress 5.9, a "context" value of "wp_get_attachment_image"
has been used in the wp_get_attachment_image() function to provide
context to underlying functions where that is relevant, e.g.
wp_get_loading_attr_default(). Since that value used to be not
customizable, it required a workaround in get_the_post_thumbnail()
to avoid calling those functions in wp_get_attachment_image(),
which resulted in unnecessary complexity and was prone to errors.

This changeset introduces a wp_get_attachment_image_context filter
and leverages it with private filter callback functions that are
leveraged by default when get_the_post_thumbnail() is called. This
avoids the need for the previous workaround and furthermore provides
flexibility for other callers of wp_get_attachment_image() to
provide their own contexts.

Props flixos90, costdev, thekt12, westonruter, spacedmonkey.
Fixes #58212.

Wed, 17 May 2023 12:04:38 GMT SergeyBiryukov [55820]

trunk/src/wp-includes/script-loader.php (modified)

trunk/src/wp-includes/style-engine.php (modified)

trunk/src/wp-includes/style-engine/class-wp-style-engine-processor.php (modified)

trunk/src/wp-includes/style-engine/class-wp-style-engine.php (modified)

Docs: Correct default value for the $optimize option in Style
Engine.

The default value is set to true in
WP_Style_Engine_Processor::get_css(), but was previously documented
as false in various DocBlocks.

Follow-up to [54156], [55719], [55733], [55819].

See #57840.

Wed, 17 May 2023 11:56:47 GMT SergeyBiryukov [55819]

trunk/src/wp-includes/script-loader.php (modified)

trunk/src/wp-includes/style-engine.php (modified)

trunk/src/wp-includes/style-engine/class-wp-style-engine-css-declarations.php (modified)

trunk/src/wp-includes/style-engine/class-wp-style-engine-css-rule.php (modified)

trunk/src/wp-includes/style-engine/class-wp-style-engine-css-rules-store.php (modified)

trunk/src/wp-includes/style-engine/class-wp-style-engine-processor.php (modified)

trunk/src/wp-includes/style-engine/class-wp-style-engine.php (modified)

Docs: Improve Style Engine DocBlocks per the documentation standards.

Follow-up to [54156], [55719], [55733].

See #57840.

Wed, 17 May 2023 09:42:02 GMT spacedmonkey [55818]

trunk/src/wp-includes/meta.php (modified)

Networks and Sites: Load WP_Metadata_Lazyloader class file if class
does not exist.

Follow on from [55747].

As get_sites can be called very early in the bootstrap process,
like in the sunrise.php file, it means that the
WP_Metadata_Lazyloader may not have been loaded yet in the wp-
settings.php file. Add a simple check to see if the class exists and
if it does not exist then load the class file in.

Props spacedmonkey, peterwilsoncc, dd32.
See #58185.

Wed, 17 May 2023 09:21:09 GMT spacedmonkey [55817]

trunk/src/wp-includes/block-template-utils.php (modified)

Editor: Disable lazy loading term meta in get_block_templates.

Pass false to the lazy_load_term_meta parameter given to the
WP_Query found in get_block_templates. Template post types only
ever have one term assigned to them. So priming term meta, does not
help performance as lazy loading term meta is only useful if loading
multiple terms. As get_block_templates is run multiple times on a
block theme request, this saves processing time.

Props spacedmonkey, andraganescu, ntsekouras, oandregal, westonruter.
Fixes #58230.

Tue, 16 May 2023 18:50:11 GMT flixos90 [55816]

trunk/src/wp-includes/media.php (modified)

trunk/tests/phpunit/tests/media.php (modified)

Media: Increase default for wp_omit_loading_attr_threshold to 3.

The previous default threshold for how many content images to skip
lazy-loading on (which was just 1) has proven to be too strict: HTTP
Archive data shows that >70% of sites have up to 3 equal-sized images
in the initial viewport, each of which could be the LCP image and
therefore should not be lazy-loaded. Lazy-loading too many images has
adverse effects on load time performance, while increasing the
default threshold will not negatively affect load time performance
even for sites where a threshold of 1 would be the perfect choice.

The change of default value in this changeset will improve
performance for more WordPress sites out of the box. The
wp_omit_loading_attr_threshold filter can still be used to
customize and fine tune the value where needed.

Props thekt12, spacedmonkey, westonruter, flixos90.
Fixes #58213.

Tue, 16 May 2023 18:38:52 GMT audrasjb [55815]

branches/6.2/package-lock.json (modified)

branches/6.2/package.json (modified)

branches/6.2/src/wp-includes/version.php (modified)

Post WordPress 6.1.1 version bump.
The 6.2 branch is now 6.2.2-alpha.

Tue, 16 May 2023 17:49:12 GMT SergeyBiryukov [55814]

tags/4.1.38 (copied)

Tag 4.1.38

Tue, 16 May 2023 17:48:17 GMT SergeyBiryukov [55813]

tags/4.2.35 (copied)

Tag 4.2.35

Tue, 16 May 2023 17:47:37 GMT SergeyBiryukov [55812]

tags/4.3.31 (copied)

Tag 4.3.31

Tue, 16 May 2023 17:46:32 GMT SergeyBiryukov [55811]

tags/4.4.30 (copied)

Tag 4.4.30

Tue, 16 May 2023 17:45:35 GMT SergeyBiryukov [55810]

tags/4.5.29 (copied)

Tag 4.5.29

Tue, 16 May 2023 17:34:18 GMT SergeyBiryukov [55809]

tags/4.6.26 (copied)

Tag 4.6.26

Tue, 16 May 2023 17:33:36 GMT SergeyBiryukov [55808]

tags/4.7.26 (copied)

Tag 4.7.26

Tue, 16 May 2023 17:32:24 GMT SergeyBiryukov [55807]

tags/4.8.22 (copied)

Tag 4.8.22

Tue, 16 May 2023 17:30:31 GMT SergeyBiryukov [55806]

tags/4.9.23 (copied)

Tag 4.9.23

Tue, 16 May 2023 17:19:46 GMT SergeyBiryukov [55805]

tags/5.0.19 (copied)

Tag 5.0.19

Tue, 16 May 2023 17:18:40 GMT SergeyBiryukov [55804]

tags/5.1.16 (copied)

Tag 5.1.16

Tue, 16 May 2023 17:17:31 GMT SergeyBiryukov [55803]

tags/5.2.18 (copied)

Tag 5.2.18

Tue, 16 May 2023 17:13:05 GMT SergeyBiryukov [55802]

tags/5.3.15 (copied)

Tag 5.3.15

Tue, 16 May 2023 17:03:12 GMT SergeyBiryukov [55801]

tags/5.4.13 (copied)

Tag 5.4.13

Tue, 16 May 2023 17:02:18 GMT SergeyBiryukov [55800]

tags/5.5.12 (copied)

Tag 5.5.12

Tue, 16 May 2023 17:00:42 GMT SergeyBiryukov [55799]

tags/5.6.11 (copied)

Tag 5.6.11

Tue, 16 May 2023 16:59:00 GMT SergeyBiryukov [55798]

tags/5.7.9 (copied)

Tag 5.7.9

Tue, 16 May 2023 16:51:10 GMT SergeyBiryukov [55797]

tags/5.8.7 (copied)

Tag 5.8.7

Tue, 16 May 2023 16:49:26 GMT SergeyBiryukov [55796]

tags/5.9.6 (copied)

Tag 5.9.6

Tue, 16 May 2023 16:47:31 GMT SergeyBiryukov [55795]

tags/6.0.4 (copied)

Tag 6.0.4

Tue, 16 May 2023 16:43:13 GMT SergeyBiryukov [55794]

tags/6.1.2 (copied)

Tag 6.1.2

Tue, 16 May 2023 16:40:08 GMT SergeyBiryukov [55793]

tags/6.2.1 (copied)

Tag 6.2.1

Tue, 16 May 2023 16:34:51 GMT audrasjb [55792]

branches/6.2/src/wp-includes/version.php (modified)

WordPress 6.2.1.

Christian Widlund · Answer 4 · Tue Jun 13 2023 18:36:50 GMT+0800 (China Standard Time)

Interesting, thanks for these links. 👍 Using your example, that would lead to this below changelog between 2 minor versions. Is it readable? Would you actually read it? Does it provide actually useful information?

For me, it's sadly a no-no-no. And this is quite painful as there is no way to use info from that. Right?

Changelog 6.2.1 to 6.2.2

no i agree! the bits you want are scattered, if there at all. It's the only thing i could find :( .
I would not read that. However when doing updates i always read the changelog.

i mean there are the web pages for releases, but as stated before, we should not have to scrape data
Maybe we should tag someone from WP. They most likely know stuff i dont! :)
It would dramatically improve all devs using composer workflow if this was in place.

@LeoColomb maybe this then

some wp peeps i could find, plz chime in on getting release notes for wp
@mtias @francescamarano @femkreations
These are the constraints for feasibility:

Systematic availability for any new WordPress tag
Content endpoint/URL can be retrieved in a deterministic way for a given tag (e.g., without the jazzy-name in the endpoint)
Available at the time of the tag public availability

Léo Colombaro · Answer 5 · Thu Jun 15 2023 06:19:42 GMT+0800 (China Standard Time)

Maybe this then

WordPress/WordPress@6.2...6.2.1

This could be a great option for minor versions.
Even though the raw listing of commits is still quite complex to read, it's something usable, at least.
But I'm not sure about the major versions. Against which other tag do you compare?
And, I mean, more than hundreds of commits?

On the other side, I found these pages for every release which are human-readable:

Listing: https://wordpress.org/documentation/wordpress-versions/
One release example: https://wordpress.org/documentation/wordpress-version/version-6-2/
There is even an API: https://wordpress.org/documentation/wp-json/wp/v2/wordpress-versions

But:

Even on API, the content is HTML (quite hard to translate to GitHub or something);
Every single release page contains an “Installation/Update Information”, which might lead to confusion.

Christian Widlund · Answer 6 · Thu Jun 15 2023 13:32:03 GMT+0800 (China Standard Time)

great find!

https://wordpress.org/documentation/wp-json/wp/v2/wordpress-versions seems better then if it conforms with the tags

BTW github supports html so you can use it as is, try it here in the comment section.

Léo Colombaro · Answer 7 · Fri Jun 16 2023 05:09:07 GMT+0800 (China Standard Time)

Alright, I might be able to generate such release notes (see below) for new versions.

If so, I'm not confident about the script life-time: upstream release note pages structure are quite heterogeneous (e.g., the one with h2/h3 mismatches), and subject to changes-without-notice. 😬
I'm also not sure about their availability in time: if the pages are not published before the 5 min after WP.org API's update, our efforts will go directly to trash! 😅

@chrillep What do you think about this?
@retlehs @swalkinshaw Opinion?

6.2.2

Sourced from WordPress.org Documentation.

Summary

The 6.2.2 minor release addresses 1 bug and 1 security issue. Because this is a security release, it is recommended that you update your sites immediately. All versions since WordPress 5.9 have also been updated.

Security updates

The security team would like to thank the following people for responsibly reporting vulnerabilities and allowing them to be fixed in this release.

Block themes parsing shortcodes in user-generated data; thanks to Liam Gladdy of WP Engine for reporting this issue.

The issue above was originally patched in the 6.2.1 release, but needed further hardening here in 6.2.2. The Core team is thankful for the community in their response to 6.2.1 and collaboration on finding the best path forward for proper resolution in 6.2.2.

Scott Walkinshaw · Answer 8 · Fri Jun 16 2023 05:23:14 GMT+0800 (China Standard Time)

While GitHub supports HTML in descriptions, wouldn't we have to write the HTML directly to a changelog file? Is there another place that Dependabot will read the contents from? Does it support GitHub releases?

I'm all in favour of trying to support some releases notes but I do think it's weird if we'd have to have a CHANGELOG.txt file that contained HTML entries.

edit: we could try and run an HTML to Markdown converter on it?

Léo Colombaro · Answer 9 · Fri Jun 16 2023 05:33:06 GMT+0800 (China Standard Time)

Does it support GitHub releases?

Yes, it does. See roots/wordpress-packager#761 for example.

I do think it's weird if we'd have to have a CHANGELOG.txt file that contained HTML entries.

Yeah, I agree. It'd be even weird to have a CHANGELOG.txt file, period. And quite hard to manage.
My idea is to use GitHub releases "notes" only. roots/wordpress-packager#762

edit: we could try and run an HTML to Markdown converter on it?

Please no 😭

Scott Walkinshaw · Answer 10 · Fri Jun 16 2023 06:31:21 GMT+0800 (China Standard Time)

Release notes it is then 🚀

Ben Word · Answer 11 · Fri Jun 16 2023 06:32:02 GMT+0800 (China Standard Time)

This is a big improvement ❤️

Christian Widlund · Answer 12 · Fri Jun 16 2023 21:22:05 GMT+0800 (China Standard Time)

i think it looks good! Great even! ❤️

Léo Colombaro · Answer 13 · Fri Jun 16 2023 22:12:15 GMT+0800 (China Standard Time)

Have run the script for a first batch: https://github.com/roots/wordpress/releases
All good?

Side notes:

Some releases have absolutely not notes:
- https://github.com/roots/wordpress/releases/tag/6.1.3
- Not the only one
GitHub Releases take release date and not the tag publication date
The “latest” release might be inconsistent

Scott Walkinshaw · Answer 14 · Fri Jun 16 2023 22:16:39 GMT+0800 (China Standard Time)

Can we also include a link to the diff for wordpress/wordpress at the end of the release description? This could help in two ways:

provides some info for releases without any notes (like 6.1.3)
I believe dependabot always generates that diff for roots/wordpress, which has no changes, so it's not helpful. This would at least point people to the correct source diff.

Léo Colombaro · Answer 15 · Fri Jun 16 2023 22:26:26 GMT+0800 (China Standard Time)

That was part of my initial target, but too complicated to achieve, at least for now:

First, the script has to understand WordPress versioning¹:
- Parsing
- Decreasing
- Case for X.Y.0
Then the question of against which other tag we compare (minor to minor is quite ok, but major is more tricky)
- Major to major might be useless: 700+ commits for WordPress/WordPress@6.1...6.2

Edit:
¹We might introduce semver as a dependency, but that shift the complexity to the GHA workflow.

Scott Walkinshaw · Answer 16 · Fri Jun 16 2023 22:28:53 GMT+0800 (China Standard Time)

Just to clarify, I only meant including that GitHub link in the release notes. Eg: WordPress/WordPress@6.1...6.2

Not including the contents of it in the actual body of the note.

Léo Colombaro · Answer 17 · Fri Jun 16 2023 22:30:00 GMT+0800 (China Standard Time)

Yes yes, still the link has to be generated 😅

Scott Walkinshaw · Answer 18 · Fri Jun 16 2023 22:31:41 GMT+0800 (China Standard Time)

😅 true! What you've done already is already a huge improvement so I think the job is done.