Add many PRs since release 2023.04 #237
Conversation
|
Found this ticket too: https://www.illumos.org/issues/14854 |
There was a problem hiding this comment.
I'm not sure about removing the old changes.
I'm of the opinion that this should be removed entirely. The new website looks to have the information already. I think it would be better for the docs to be a general reference and changelogs don't fit into that.
| Portions created by Aurelien Larcher are Copyright (C) 2018. | ||
| Portions created by Ken Mays are Copyright (C) 2014. | ||
| Portions created by Michal Nowak are Copyright (C) 2020. |
There was a problem hiding this comment.
If these contributions are to be removed, then the authors should probably also be removed.
There was a problem hiding this comment.
I'm not sure about removing the old changes.
Hopefully they are not removed, I'll check, ...hmm, oops!
We have a dilemma: 'latest-changes' should be latest changes, and not going back 10 years or so---maybe going back as far as the previous ISO release (or whatever!). But we shouldn't throw away the old stuff either; maybe
move the older stuff to archive-releases? I could add this to the PR.
The new website looks to have the information already...
Where? I cannot find detailed release notes there, except for general stuff. (Can you correct me if I' wrong.)
Generally, release notes are based on PRs, which are taken from the code, which is here; so the new Website would only provide a link to here.
Anyway, whether here, there or somewhere else; someone is going to have to generate and document the changes, which will have to be done by someone and I doubt it whether there are too many show of hands.
Release notes are important to any project, and we don't have any and I think we should do something about it, which is why I made this PR.
I've also commented in the ticket that the best way to automate this is for each PR to include a keyword, i.e., REL somewhere in the title of the PR, so that PR can be included in release notes (a lot of PRs are just forced re-builds or whatnot and should not 'clutter' the release notes. It would then be easy to parse only those PRs with the keyword to build the release notes.
So how to proceed?
There was a problem hiding this comment.
The detailed log section of the Hipster 2023.04 Announcement contains a lot of information on version upgrades. Much more than is in this PR. This seems odd as I would expect this to be the same. There is a need for a release notes section, but I'm not sure either is adequate currently.
So far as latest changes vs old changes, there could be a separate page with all of the old changes. With this page containing only the latest changes?
Edit: I see your additions are only PRs made after the release, which explains the difference. I think it would be better to have an automated solution which was part of the main website and not these docs. Simply because there's no good solution to dynamically update the docs without many automated PRs which would create a lot of clutter.
release-notes/latest-changes
Included only some PRs since 2023.04; but needs editing and PRs before 2023. Might be able to help to do this, but require pointers as to which PRs to include/exclude.
There have been many PRs since the release a couple of days ago; but many of these are forced rebuilds; but many are relevant, i.e., new packages etc.
We could easily automate this with a script; but we wouldn't want to include all PRs, just the relevant ones. But how do we figure out which PRs are relevant? Maybe some keyword in the title of the PR?