phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[doc] Move the changelog to docs as "pmd_release_notes"

Browse Source 
Also update the release scripts
This commit is contained in:
Andreas Dangel 2017-08-15 14:08:48 +02:00
parent 23d947b4bf
commit c8c4b73c80
7 changed files with 66 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.travis/build-deploy.sh
View File

@ -49,7 +49,7 @@ elif travis_isPush; then
# Uploading pmd distribution to sourceforge
rsync -avh pmd-dist/target/pmd-*-${VERSION}.zip ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/
rsync -avh src/site/markdown/overview/changelog.md ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/ReadMe.md
rsync -avh docs/pages/release_notes.md ${PMD_SF_USER}@web.sourceforge.net:/home/frs/project/pmd/pmd/${VERSION}/ReadMe.md
else
echo "This is neither a pull request nor a push!"

2
.travis/release.sh
View File

@ -18,7 +18,7 @@ curl -H "Accept: application/json" -X PUT -d "default=windows&default=mac&defaul
# Assumes, the release has already been created by travis github releases provider
RELEASE_ID=$(curl -s -H "Authorization: token ${GITHUB_OAUTH_TOKEN}" https://api.github.com/repos/pmd/pmd/releases/tags/pmd_releases/${RELEASE_VERSION}|jq ".id")
RELEASE_NAME="PMD ${RELEASE_VERSION} ($(date -u +%d-%B-%Y))"
RELEASE_BODY=$(tail -n +3 src/site/markdown/overview/changelog.md) # skips the first 2 lines - the heading 'PMD Release Notes'
RELEASE_BODY=$(tail -n +6 docs/pages/release_notes.md) # skips the first 6 lines - the heading 'PMD Release Notes'
RELEASE_BODY="${RELEASE_BODY//'\'/\\\\}"
RELEASE_BODY="${RELEASE_BODY//$'\r'/}"
RELEASE_BODY="${RELEASE_BODY//$'\n'/\\r\\n}"

22
do-release.sh
View File

@ -60,7 +60,7 @@ export RELEASE_VERSION
export DEVELOPMENT_VERSION
export CURRENT_BRANCH
echo "* Update version/release info in **src/site/markdown/overview/changelog.md**."
echo "* Update version/release info in **docs/pages/release_notes.md**."
echo
echo " ## $(date -u +%d-%B-%Y) - ${RELEASE_VERSION}"
echo
@ -97,7 +97,7 @@ cat <<EOF
PMD ${RELEASE_VERSION} released
* minor version with lots of bug fixes
* Changelog: https://pmd.github.io/pmd-${RELEASE_VERSION}/overview/changelog.html
* Release Notes: https://pmd.github.io/pmd-${RELEASE_VERSION}/pmd_release_notes.html
* Downloads: https://github.com/pmd/pmd/releases/tag/pmd_releases%2F${RELEASE_VERSION}
* Fixed Bugs: https://sourceforge.net/p/pmd/bugs/milestone/PMD-${RELEASE_VERSION}/
* Documentation: https://pmd.github.io/pmd-${RELEASE_VERSION}/
@ -113,11 +113,15 @@ echo
echo
echo
echo "Prepare Next development version:"
echo "* Move version/release info from **src/site/markdown/overview/changelog.md** to **src/site/markdown/overview/changelog-old.md**."
echo "* Update version/release info in **src/site/markdown/overview/changelog.md**."
echo "* Move version/release info from **docs/pages/release_notes.md** to **docs/pages/release_notes_old.md**."
echo "* Update version/release info in **docs/pages/release_notes.md**."
echo
cat <<EOF
# PMD Release Notes
---
title: PMD Release Notes
permalink: pmd_release_notes.html
keywords: changelog, release notes
---
## ????? - ${DEVELOPMENT_VERSION}
@ -127,10 +131,10 @@ This is a bug fixing release.
### Table Of Contents
* [New and noteworthy](#New_and_noteworthy)
* [Fixed Issues](#Fixed_Issues)
* [API Changes](#API_Changes)
* [External Contributions](#External_Contributions)
* [New and noteworthy](#new-and-noteworthy)
* [Fixed Issues](#fixed-issues)
* [API Changes](#api-changes)
* [External Contributions](#external-contributions)
### New and noteworthy

6
docs/_data/sidebars/pmd_sidebar.yml
View File

@ -27,6 +27,9 @@ entries:
url: /index.html
output: web, pdf
type: homepage
- title: "Release Notes"
url: /pmd_release_notes.html
output: web, pdf
- title: Getting Started
url: /pmd_userdocs_getting_started.html
output: web, pdf
@ -69,6 +72,9 @@ entries:
- title: What does 'PMD' mean?
url: /pmd_userdocs_meaning.html
output: web, pdf
- title: Old Release Notes
url: /pmd_release_notes_old.html
output: web, pdf
- title: Rule Reference
output: web, pdf
folderitems:

37
docs/pages/pmd/devdocs/releasing.md
View File

@ -29,7 +29,7 @@ Make sure code is up to date and everything is committed and pushed with git:
At a very minimum, the current date must be noted in the release notes. Also, the version
must be adjusted. E.g. by removing "-SNAPSHOT".
You can find the release notes here: `src/site/markdown/overview/changelog.md`.
You can find the release notes here: `docs/pages/release_notes.md`.
The release notes usual mention any new rules that have been added since the last release.
Please double check the file `pmd-core/src/main/resources/rulesets/releases/<version>.xml`, so
@ -121,32 +121,37 @@ the following template:
### Prepare the new release notes
* Move version/release info from **src/site/markdown/overview/changelog.md** to **src/site/markdown/overview/changelog-old.md**.
* Update version/release info in **src/site/markdown/overview/changelog.md**. Use the following template:
* Move version/release info from **docs/pages/release_notes.md** to **docs/pages/release_notes_old.md**.
* Update version/release info in **docs/pages/release_notes.md**. Use the following template:
```
# PMD Release Notes
---
title: PMD Release Notes
permalink: pmd_release_notes.html
keywords: changelog, release notes
---
## ????? - ${DEVELOPMENT_VERSION}
## ????? - ${DEVELOPMENT_VERSION}
The PMD team is pleased to announce PMD ${DEVELOPMENT_VERSION%-SNAPSHOT}.
The PMD team is pleased to announce PMD ${DEVELOPMENT_VERSION%-SNAPSHOT}.
This is a bug fixing release.
This is a bug fixing release.
### Table Of Contents
### Table Of Contents
* [New and noteworthy](#New_and_noteworthy)
* [Fixed Issues](#Fixed_Issues)
* [API Changes](#API_Changes)
* [External Contributions](#External_Contributions)
* [New and noteworthy](#new-and-noteworthy)
* [Fixed Issues](#fixed-issues)
* [API Changes](#api-changes)
* [External Contributions](#external-contributions)
### New and noteworthy
### New and noteworthy
### Fixed Issues
### Fixed Issues
### API Changes
### API Changes
### External Contributions
### External Contributions
```
Commit and push

36
src/site/markdown/overview/changelog.md → docs/pages/release_notes.md
View File

@ -1,4 +1,8 @@
# PMD Release Notes
---
title: PMD Release Notes
permalink: pmd_release_notes.html
keywords: changelog, release notes
---
## ????? - 6.0.0-SNAPSHOT
@ -8,18 +12,18 @@ This is a major release.
### Table Of Contents
* [New and noteworthy](#New_and_noteworthy)
* [Revamped Apex CPD](#Revamped_Apex_CPD)
* [Java Type Resolution](#Java_Type_Resolution)
* [Metrics Framework](#Metrics_Framework)
* [Configuration Error Reporting](#Configuration_Error_Reporting)
* [Java Symbol Table](#Java_Symbol_Table)
* [Apex Parser Update](#Apex_Parser_Update)
* [Modified Rules](#Modified_Rules)
* [Removed Rules](#Removed_Rules)
* [Fixed Issues](#Fixed_Issues)
* [API Changes](#API_Changes)
* [External Contributions](#External_Contributions)
* [New and noteworthy](#new-and-noteworthy)
* [Revamped Apex CPD](#revamped-apex-cpd)
* [Java Type Resolution](#java-type-resolution)
* [Metrics Framework](#metrics-framework)
* [Configuration Error Reporting](#configuration-error-reporting)
* [Java Symbol Table](#java-symbol-table)
* [Apex Parser Update](#apex-parser-update)
* [Modified Rules](#modified-rules)
* [Removed Rules](#removed-rules)
* [Fixed Issues](#fixed-issues)
* [API Changes](#api-changes)
* [External Contributions](#external-contributions)
### New and noteworthy
@ -27,12 +31,12 @@ This is a major release.
We are now using the Apex Jorje Lexer to tokenize Apex code for CPD. This change means:
* All comments are now ignored for CPD. This is consistent with how other languages such as Java and Groovy work.
* Tokenization honors the language specification, which improves accuracy.
* All comments are now ignored for CPD. This is consistent with how other languages such as Java and Groovy work.
* Tokenization honors the language specification, which improves accuracy.
CPD will therefore have less false positives and false negatives.
#### Java Type Resolution
#### Java Type Resolution
As part of Google Summer of Code 2017, [Bendegúz Nagy](https://github.com/WinterGrascph)'s work on type resolution for Java continues.
For this release he has extended support for method calls for both instance and static methods.

5
src/site/markdown/overview/changelog-old.md → docs/pages/release_notes_old.md
View File

@ -1,4 +1,7 @@
# Old Changelog
---
title: Old Release Notes
permalink: pmd_release_notes_old.html
---
Previous versions of PMD can be downloaded here:
http://sourceforge.net/projects/pmd/files/pmd/