-
-
Notifications
You must be signed in to change notification settings - Fork 188
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
Automate inclusion of release notes into Plone 6 documentation #3915
Comments
For Volto it could be improved. It looks like this simply gets the Perhaps the But at least there is something, which cannot be said for the backend/Classic UI. |
The release notes are hand compiled by me in the coredev buildout repo. Latest release notes are then here, for 6.0.10.1. The changelog is automatically generated using
Afterwards, I do a small bit of cleanup, because some warnings are printed. I call it One possible way of including this in the docs, would be to create a Instead of copying it from git tags, we could copy it from dist.plone.org/release, where every release has its own directory. The contents should be the same. I am happy to adjust the MarkDown of future release notes if needed, as long as I can copy them to community.plone.org as announcement. And yes: having these in the docs would be nice! |
I am not sure what you look at? We capture all minor and bugfix releases for Volto. This: https://github.com/plone/volto/blob/main/packages/volto/CHANGELOG.md#1740-2023-11-04 Renders as this: https://6.docs.plone.org/volto/release-notes/index.html#id52 |
MyST can parse both .rst and .md files. There is a utility that can convert markup from reStructuredText to MyST that we used for all the repos that are included in the Plone 6 Documentation, plus a few that have already been converted from Plone 5.2 Documentation just waiting for someone to review them for accuracy and get ported to Plone 6.0 Documentation. See Importing external docs and converting to MyST. It's pretty good, and requires minimal cleanup, depending on the quality of the original reStructuredText, of course. I am happy to do one-time conversions and clean-ups, if that is a barrier. |
That is Volto 17.4.0. Latest is 17.15.4: And latest from Volto 16 should not be 16.21.1, but 16.31.3: Maybe the Volto release notes in the docs should have one directory or file for Volto 18, one for 17, one for 16. But the earlier parts of the Volto 17 notes would be there twice, and the earlier Volto 16 notes even three times. |
Oh, yikes, you're right. That's misleading, as if Volto 17.4.0 was the latest release of that branch. Let's ask @sneridagh to think about this, as it would affect his workflow, and he might have a trick or two up his sleeve. |
I just noticed that we do not have Plone release notes in Plone 6 Documentation. I also do not know whether we have them compiled in a single file anywhere.
We have Volto release notes automatically included. Let's do the same for Plone. Here's what Volto does: https://github.com/search?q=repo%3Aplone%2Fvolto%20copyreleasenotestodocs&type=code
What are the bits and pieces that need to be identified and put together?
The text was updated successfully, but these errors were encountered: