Revision: 1143
Author: [email protected]
Date: Sat Apr 16 15:15:59 2011
Log: For ReleaseChecklist wiki, cleanup formatting and adding
additional notes/learnings from 1.3.1 release
http://code.google.com/p/piccolo2d/source/detail?r=1143
Modified:
/wiki/ReleaseChecklist.wiki
=======================================
--- /wiki/ReleaseChecklist.wiki Fri Apr 1 20:57:18 2011
+++ /wiki/ReleaseChecklist.wiki Sat Apr 16 15:15:59 2011
@@ -1,127 +1,76 @@
#summary Release checklist.
-= Introduction =
-
= Checklist =
-
-No Open issues exist with current release milestone
-
-[http://code.google.com/p/piccolo2d/issues/list?can=2&q=milestone=1.3.1&colspec=ID%20Type%20Status%20Priority%20Milestone%20Owner%20Toolkit%20Component%20Summary
Milestone:1.3.1,Open
issues]
-
-
-<br/>
-No Fixed issues exist with the current release milestone (all closed
issues should be in Duplicate, WontFix, or Verified status)
-
-[http://code.google.com/p/piccolo2d/issues/list?can=1&q=Milestone:1.3.1%20status=Fixed&sort=status&colspec=ID%20Type%20Status%20Priority%20Milestone%20Owner%20Toolkit%20Component%20Summary
Milestone:1.3.1,status=Fixed]
-
-
-<br/>
-===For each of {beta, rc1, rc2, ...} release candidates:===
-
-Clean checkout of trunk from subversion
-
+===Verify Issues===
+ # Verify that no Open issues exist with current release milestone:
+ *
[http://code.google.com/p/piccolo2d/issues/list?can=2&q=milestone=1.3.1&colspec=ID%20Type%20Status%20Priority%20Milestone%20Owner%20Toolkit%20Component%20Summary
Milestone:1.3.1,Open issues]
+ # Verify that no Fixed issues exist with the current release milestone
+ * (All closed issues should be in Duplicate, WontFix, or Verified
status
+ *
[http://code.google.com/p/piccolo2d/issues/list?can=1&q=Milestone:1.3.1%20status=Fixed&sort=status&colspec=ID%20Type%20Status%20Priority%20Milestone%20Owner%20Toolkit%20Component%20Summary
Milestone:1.3.1,status=Fixed]
+===Release Candidates===
+ * For each of {beta, rc1, rc2, ...} release candidates:
+ # Clean checkout of trunk (or primary branch) from subversion:
{{{
$ svn checkout https://piccolo2d.googlecode.com/svn/piccolo2d.java/trunk
piccolo2d.java-trunk
$ cd piccolo2d.java-trunk
}}}
-
-<br/>
-Update version in parent pom.xml file to {$version}-${release-candidate}
-
-parent/pom.xml:
+ # Update version in all pom.xml files to
{$version}-${release-candidate}
+ * `*`/pom.xml:
{{{
<version>1.3.1-rc1</version>
}}}
-
-
-<br/>
-Working directory builds and all tests pass on all platforms
+ # Verify that working directory builds and all tests pass on all
platforms:
{{{
$ mvn install
}}}
-
-<br/>
-Examples run with jdk 1.4+ on all platforms
-
+ # Verify that the examples run with jdk 1.4+ on all platforms
{{{
$ cd examples
$ mvn assembly:assembly
$ java -jar target/piccolo2d-examples-1.3.1-rc1-jar-with-dependencies.jar
}}}
-
-_Note: The maven assembly plugin is deprecating (see
[http://maven.apache.org/plugins/maven-assembly-plugin/plugin-info.html
here]) all goals (including assembly:assembly) except for assembly:single.
However, mvn assembly:single failed to correctly build the assembly; likely
having something to do with [http://jira.codehaus.org/browse/MASSEMBLY-94
this ticket]. The workaround is to use "mvn clean package assembly:single"
or use mvn assembly:assembly so long as it is still available._
-
-<br/>
-SWT examples run with jdk 1.4+ on all platforms
-
+ * _Note: The maven assembly plugin is deprecating (see
[http://maven.apache.org/plugins/maven-assembly-plugin/plugin-info.html
here]) all goals (including assembly:assembly) except for assembly:single.
However, mvn assembly:single currently fails to correctly build the
assembly; likely having something to do with
[http://jira.codehaus.org/browse/MASSEMBLY-94 this Maven ticket]. The
workaround is to use run the clean and package phase at the same time as
assembly:single (i.e., {{{mvn clean package assembly:single"}}}) or use mvn
assembly:assembly so long as it is still available._
+ # Verify that the SWT examples run with jdk 1.4+ on all platforms
{{{
$ cd ../swt-examples
$ mvn assembly:assembly
$ java -jar
target/piccolo2d-swt-examples-1.3.1-beta-jar-with-dependencies.jar
}}}
-
-<br/>
-Clirr report shows no ERRORs where binary compatibility is required
-
-For example, for minor release version 1.3.1, core must be binary
compatible with the latest minor release version, 1.3.
+ # Verify that {{{clirr}}} report shows no ERRORs where binary
compatibility is required
+ * For example, for minor release version 1.3.1, core must be binary
compatible with the latest minor release version, 1.3.
{{{
$ clirr.sh --old-version piccolo2d-core-1.3.jar --new-version
piccolo2d-core-1.3.1-rc1.jar --style text
}}}
-
-<br/>
-All source files have the Piccolo2D license header
-
-<br/>
-Class file format of all jar files matches the minimum required JDK
version, currently 1.4
-
-<br/>
-Update release notes and readme as necessary
-
-<br/>
-Commit release candidate changes to trunk
-
+ # Verify that all source files have the Piccolo2D license header
+ # Class file format of all jar files matches the minimum required JDK
version, currently 1.4
+ * _Note: I did this by unzipping the built jars and using
{{{javap}}}; there may be a better way to do this verification, or perhaps
we should author a script._
+ # Update release notes and readme as necessary
+ # Commit release candidate changes to trunk
{{{
$ svn commit -m "updating version to 1.3.1-rc1" .
}}}
-
-<br/>
-Create release tag in subversion
-
+ # Create release tag in subversion
{{{
$ svn cp -m "creating 1.3.1-rc1 release tag"
https://piccolo2d.googlecode.com/svn/piccolo2d.java/trunk
https://piccolo2d.googlecode.com/svn/piccolo2d.java/tags/release-1.3.1-rc1
}}}
-
-====Create binary, source, and javadoc release artifacts====
-
-To create binary zip and binary tar.gz files, update the VERSION shell
variable and call
-
+ # Create binary, source, and javadoc release artifacts
+ * To create binary zip and binary tar.gz files, update the VERSION
shell variable and call
{{{
$ ./create-bin.sh
}}}
-
-To create source zip and source tar.gz files, update the VERSION shell
variable and call
-
+ * To create source zip and source tar.gz files, update the VERSION
shell variable and call
{{{
$ ./create-src.sh
}}}
-
-These scripts are currently attached to Issue 146 and will probably live
in svn shortly.
-
-====Create new downloads on Google Code====
-
-Visit
-
-http://code.google.com/p/piccolo2d/downloads/list
-
-Click [http://code.google.com/p/piccolo2d/downloads/entry New download]
link and upload binary zip, binary tar.gz, source zip, and source tar.gz
files. Refer to previous uploads for what the metadata should look like.
-
-Deprecate earlier failed release candidate version downloads, if any.
-
+ * These scripts are currently attached to Issue 146 and will
probably live in svn shortly.
+ # Create new downloads on Google Code
+ * Visit http://code.google.com/p/piccolo2d/downloads/list
+ * Click [http://code.google.com/p/piccolo2d/downloads/entry New
download] link and upload binary zip, binary tar.gz, source zip, and source
tar.gz files. Refer to previous uploads for what the metadata should look
like.
+ * Deprecate earlier failed release candidate version downloads, if
any.
====For release candidate versions====
Send a VOTE email to the dev and user mailing lists,
-
{{{
Subject: [VOTE] Release Piccolo2D.Java ${version}
@@ -165,33 +114,24 @@
===After final release tag:===
-Create release branch in subversion
-
+ * Create release branch in subversion
{{{
$ svn cp -m "creating 1.3.1 release branch"
https://piccolo2d.googlecode.com/svn/piccolo2d.java/trunk
https://piccolo2d.googlecode.com/svn/piccolo2d.java/branches/release-1.3.1
}}}
-
-
-<br/>
-Create bundle(s) for upload to maven central repository
+ * Create bundle(s) for upload to maven central repository
*TODO*
-
-<br/>
-Update version in parent pom.xml file on svn trunk to
${next-version}-SNAPSHOT
-
+ * Update version in parent pom.xml file on svn trunk to
${next-version}-SNAPSHOT
parent/pom.xml:
{{{
<version>1.4-SNAPSHOT</version>
}}}
and commit
-
{{{
$ svn commit -m "updating version to 1.4-SNAPSHOT" parent/pom.xml
}}}
-
= References =
--
Piccolo2D Developers Group: http://groups.google.com/group/piccolo2d-dev?hl=en
