[doc] Update release notes for PMD 7.0.0-rc1#4373
Conversation
Generated by 🚫 Danger |
ba4b970 to
d9bc265
Compare
jsotuyod
left a comment
There was a problem hiding this comment.
I think we should also probably explicitly mention that we split away CLI into pmd-cli and Ant into pmd-ant, which were originally part of pmd-core… most integrations are probably relying on either of them (and I'd expect specially on Ant, ie: Gradle)…
Maybe a dedicated section named Notes for integrators, reinforcing that, as a major release, this is a major rewrite, and we did these changes, along with removing the old PMD class, and explicitly marking which classes are internal and subject to change and which not, and therefore expect all integrators to require some level of change to adapt, and guide people to look at the deprecations notes for more details.
58b4c1a to
0ece932
Compare
|
FYI - I've created the gif using the following commands: Record screen cast with https://github.com/EasyScreenCast/EasyScreenCast (a gnome3 extension) |
Note: not all rules have been removed yet
Note: not all rules have been removed yet
Co-authored-by: Juan Martín Sotuyo Dodero <juansotuyo@gmail.com> Co-authored-by: Clément Fournier <clement.fournier@tu-dresden.de>
Co-authored-by: Juan Martín Sotuyo Dodero <juansotuyo@gmail.com>
db8e491 to
c267809
Compare
adangel
left a comment
There was a problem hiding this comment.
I think, we should create two release notes pages: Our usual "release_notes.md" and additionally a "release_notes_PMD7.md".
The reason is, that it becomes longer and longer.
The usual "release_notes.md", which will also be used for the release notes on GitHub Releases, should IMHO be a bit shorted and mention each topic with one or two sentences and point to a more detailed section in the other release note page. It should be concise and just have a pointer to the details, if someone is interested.
The new "release_notes_PMD7.md" would then be longer and contain all the details. The page title could be "Detailed Release Notes for PMD7". E.g. it also contains the list of deprecated APIs we collected from all the PMD6 releases - these are currently in "next_major_development.md".
The page could also serve as a migration guide (#4294) or at least be the basis for such a guide.
- fix baseurl - fix "pmd designer" call - clarify release candidates
Main release notes are much shorter. The full details is in a separate page. Started to migrated Java Clean Changes from wiki.
|
IMHO this is now ready. I've made the main release notes a bit smaller and more concise: https://github.com/adangel/pmd/blob/pmd7-update-release-notes/docs/pages/release_notes.md There's now a second page, which contains the full details: https://github.com/adangel/pmd/blob/pmd7-update-release-notes/docs/pages/release_notes_pmd7.md This second page was originally the "next_major_development" page - I've merged the contents. It's not fully fledged out yet for Java, but I think, we can finish this with the next RCs. |
[skip ci] Co-authored-by: Clément Fournier <clement.fournier76@gmail.com>
Preview: https://github.com/adangel/pmd/blob/pmd7-update-release-notes/docs/pages/release_notes.md
and https://github.com/adangel/pmd/blob/pmd7-update-release-notes/docs/pages/release_notes_pmd7.md
Describe the PR
The goal is to complete the release notes for PMD 7.0.0-rc1.
https://github.com/apache/maven-gh-actions-shared/blob/main/.github/release-drafter.yml