Skip to content

Commit

Permalink
Update release docu
Browse files Browse the repository at this point in the history
  • Loading branch information
adangel committed Nov 12, 2018
1 parent 0e90269 commit 4c1a014
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions do-release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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..."
Expand Down
3 changes: 3 additions & 0 deletions docs/pages/pmd/projectdocs/committers/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<version>.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 <version>"
Expand Down

0 comments on commit 4c1a014

Please sign in to comment.