From 4c1a0145f51a9a6949e140ba7f8739b7cc924f9f Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Mon, 12 Nov 2018 20:14:54 +0100 Subject: [PATCH] Update release docu --- do-release.sh | 3 +++ docs/pages/pmd/projectdocs/committers/releasing.md | 3 +++ 2 files changed, 6 insertions(+) diff --git a/do-release.sh b/do-release.sh index 63a1bb92f9..a38a055660 100755 --- a/do-release.sh +++ b/do-release.sh @@ -75,6 +75,9 @@ echo echo "* Ensure all the new rules are listed in the proper file:" echo " ${RELEASE_RULESET}" echo +echo "* Update **docs/pages/next_major_development.md** with the API changes for" +echo " the new release based on the release notes" +echo echo "* Update **../pmd.github.io/_config.yml** to mention the new release" echo echo "Press enter to continue..." diff --git a/docs/pages/pmd/projectdocs/committers/releasing.md b/docs/pages/pmd/projectdocs/committers/releasing.md index 4800ca41fc..4aeeb7e1a2 100644 --- a/docs/pages/pmd/projectdocs/committers/releasing.md +++ b/docs/pages/pmd/projectdocs/committers/releasing.md @@ -40,6 +40,9 @@ The release notes usual mention any new rules that have been added since the las Please double check the file `pmd-core/src/main/resources/rulesets/releases/.xml`, so that all new rules are listed. +We maintain a documentation for the [next major release](pmd_next_major_development.html). Copy the API +changes from the current release notes to this document: `docs/pages/next_major_development.md`. + Check in all (version) changes to branch master or any other branch, from which the release takes place: $ git commit -a -m "Prepare pmd release "