Closed chrillep closed 1 year ago
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:
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 :)
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?
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:
Maybe this then
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:
But:
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.
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?
Sourced from WordPress.org Documentation.
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.
The security team would like to thank the following people for responsibly reporting vulnerabilities and allowing them to be fixed in this release.
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.
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?
Does it support GitHub releases?
Yes, it does. See https://github.com/roots/wordpress-packager/pull/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. https://github.com/roots/wordpress-packager/pull/762
edit: we could try and run an HTML to Markdown converter on it?
Please no 😭
Release notes it is then 🚀
This is a big improvement ❤️
i think it looks good! Great even! ❤️
Have run the script for a first batch: https://github.com/roots/wordpress/releases All good?
Side notes:
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:
roots/wordpress
, which has no changes, so it's not helpful. This would at least point people to the correct source diff. That was part of my initial target, but too complicated to achieve, at least for now:
Edit: 1We might introduce semver as a dependency, but that shift the complexity to the GHA workflow.
Just to clarify, I only meant including that GitHub link in the release notes. Eg: https://github.com/WordPress/WordPress/compare/6.1...6.2
Not including the contents of it in the actual body of the note.
Yes yes, still the link has to be generated 😅
😅 true! What you've done already is already a huge improvement so I think the job is done.
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