diff --git a/.travis/build-deploy.sh b/.travis/build-deploy.sh index 4f15d505cd..4405fa145b 100755 --- a/.travis/build-deploy.sh +++ b/.travis/build-deploy.sh @@ -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!" diff --git a/.travis/release.sh b/.travis/release.sh index 2d0cd8c040..56746a21e3 100755 --- a/.travis/release.sh +++ b/.travis/release.sh @@ -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}" diff --git a/do-release.sh b/do-release.sh index 663005fe9b..5023077a28 100755 --- a/do-release.sh +++ b/do-release.sh @@ -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 <.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 diff --git a/src/site/markdown/overview/changelog.md b/docs/pages/release_notes.md similarity index 92% rename from src/site/markdown/overview/changelog.md rename to docs/pages/release_notes.md index d301c00833..88eca7079e 100644 --- a/src/site/markdown/overview/changelog.md +++ b/docs/pages/release_notes.md @@ -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. diff --git a/src/site/markdown/overview/changelog-old.md b/docs/pages/release_notes_old.md similarity index 99% rename from src/site/markdown/overview/changelog-old.md rename to docs/pages/release_notes_old.md index 60f8c633db..147033934a 100644 --- a/src/site/markdown/overview/changelog-old.md +++ b/docs/pages/release_notes_old.md @@ -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/