hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

pmd: improved the release process documentation

Browse Source 
git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@7624 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
Andreas Dangel
2012-01-31 20:22:35 +00:00
parent 598a293dae
commit d54a66857c
3 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
pmd/etc/changelog.txt
View File

@ -1,4 +1,4 @@
January 31, 2012 - 5.0-alpha
???? ??, 2012 - 5.0:
TODO - Release blockers - Must implement before this release can be finally finished
@ -41,6 +41,9 @@ TODO - Release blockers - Must implement before this release can be finally fini
---
January 31, 2012 - 5.0-alpha:
This version of PMD breaks API compatibility with prior versions of PMD, as well
as RuleSet XML compatibility. Also the maven coordinates (groupId) have been changed.
The decision to break compatibility, allows PMD
@ -487,7 +490,7 @@ New JSP rules:
Basic ruleset: NoInlineScript
New ECMAScript rules:
Basic ruleset: AssignmentInOperand,ConsistentReturn,InnaccurateNumericLiteral,ScopeForInVariable,UnreachableCode
Basic ruleset: AssignmentInOperand,ConsistentReturn,InnaccurateNumericLiteral,ScopeForInVariable,UnreachableCode,EqualComparison,GlobalVariable
Braces ruleset: ForLoopsMustUseBraces,IfStmtsMustUseBraces,IfElseStmtsMustUseBraces,WhileLoopsMustUseBraces
Unnecessary ruleset: UnnecessaryParentheses,UnnecessaryBlock

20
pmd/etc/release_process.txt
View File

@ -8,7 +8,7 @@ $ svn status
Ensure all the new rules are listed in a src/main/resources/rulesets/releases/<version>.xml file.
Update the "download" and "what's new" link in navigation.xml.
Update the "download" and "what's new" link in site.pre.xml.
Update version/release info in etc/changelog.txt.
@ -16,15 +16,17 @@ $ mvn verify post-site (order of targets DOES matter)
Unzip and test manually (just to be on the safe side of the road):
./bin/pmd.sh ~/tmp/Test.java xml java-unusedcode
./bin/pmd.sh ~/tmp/Test.java html rulesets/unusedcode.xml
./bin/run.sh pmd ~/tmp/Test.java xml java-unusedcode
./bin/run.sh pmd ~/tmp/Test.java html rulesets/java/unusedcode.xml
Check in all (version) changes to trunk:
$ svn ci -m "pmd: Prepare pmd release <version>"
Let the maven create a release branch (note - this is of course not needed if you are already on a release/maintenance
branch). Maven will automatically increase the version in trunk.
Let maven create a release branch (note - this is of course not needed if you are already on a release/maintenance
branch). Maven will automatically increase the version in trunk. In case you create a alpha/preview release and you
want to stay with the current version in trunk, use these
additional properties: -DupdateBranchVersions=true -DupdateWorkingCopyVersions=false
$ mvn release:branch -DbranchName=<version>.x
@ -37,6 +39,8 @@ Now let maven create a release tag.
$ mvn release:clean release:prepare
Note: For the tag/label name we currently use this naming pattern: pmd_release_<major-version>_<minor-version>
The next command will checkout PMD from the tag just created and will build and deploy it
to sonatype OSS repositories:
@ -62,11 +66,11 @@ Finally, in order to publish the release to Maven central, you need to release P
Public the release on sourceforge:
- Go to Admin, File Releases, Add release
- Paste stuff into the changelog/readme boxes
Publish the release on sourceforge:
- Go to Files, to folder "pmd", create a new subfolder for the new version
- Add the pmd-<version>-bin.zip file
- Add the pmd-<version>-src.zip file
- Add the file etc/changelog.txt as ReadMe.txt file
Upload command below will create and upload the maven artifacts to sourceforge. Login info
for 'pmd-repo' and 'pmd-site' must be defined in ~/.m2/settings.xml

4
pmd/src/site/site.pre.xml
View File

@ -24,8 +24,8 @@
<item href="/index.html" name="Download PMD 5.0"/>
<item href="http://pmd.adabolo.de/job/pmd-trunk/changes" name="What's new in PMD 5.0"/>
<!--
<item name="Download PMD 5.0" href="http://sourceforge.net/project/showfiles.php?group_id=56262&amp;package_id=51441&amp;release_id=524515" />
<item name="What's new in PMD 5.0" href="http://sourceforge.net/project/shownotes.php?release_id=524515&amp;group_id=56262" />
<item name="Download PMD 5.0" href="http://sourceforge.net/projects/pmd/files/pmd/5.0/pmd-bin-5.0.zip/download" />
<item name="What's new in PMD 5.0" href="https://sourceforge.net/projects/pmd/files/pmd/5.0/" />
-->
<item href="/news.html" name="PMD in the news"/>
<item href="/products.html" name="PMD-related products and books"/>