Author: psharples
Date: Wed Apr 25 15:27:47 2012
New Revision: 1330343
URL: http://svn.apache.org/viewvc?rev=1330343&view=rev
Log:
more layout updates
Modified:
incubator/wookie/site/trunk/content/wookie/docs/developer/release-process.mdtext
Modified:
incubator/wookie/site/trunk/content/wookie/docs/developer/release-process.mdtext
URL:
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/developer/release-process.mdtext?rev=1330343&r1=1330342&r2=1330343&view=diff
==============================================================================
---
incubator/wookie/site/trunk/content/wookie/docs/developer/release-process.mdtext
(original)
+++
incubator/wookie/site/trunk/content/wookie/docs/developer/release-process.mdtext
Wed Apr 25 15:27:47 2012
@@ -51,95 +51,94 @@ Additionally there are 3 Nexus artifacts
(the difference between this and #3 is that this one is configured &
bundled with Derby DB.)
## Steps to making a release
-
+
### 1. Resolve Outstanding JIRA issues marked against this planned release
- 1. Analyse open issues
- 1. Issues should be FIXED and verified to ensure they are truly
fixed and thus marked as verified
- 1. Alternatively, in some cases open issues can be moved to the
next planned release
- 1. No open issues should remain against this intended release
before continuing
- - The only exception to this is if an issue directly
addresses the build process, such as "create build for release" type issue.
-
+ 1. Analyse open issues
+ 1. Issues should be FIXED and verified to ensure they are truly fixed and
thus marked as verified
+ 1. Alternatively, in some cases open issues can be moved to the next planned
release
+ 1. No open issues should remain against this intended release before
continuing
+ - The only exception to this is if an issue directly addresses the build
process, such as "create build for release" type issue.
+
### 2. Communicate with committers regarding new release
- Send an email to [email protected] and start a vote to
discuss whether everybody agrees it is okay to go ahead and make a release.
- Ideally we'd want a +3 from the committers, but this is not always
possible.
-
+Send an email to [email protected] and start a vote to discuss
whether everybody agrees it is okay to go ahead and make a release.
+Ideally we'd want a +3 from the committers, but this is not always possible.
+
### 3. Check all Licenses, notices and other related files
- 1. Check the following files found at the root of the trunk.
(They are bundled with all the builds, except in the case of LICENSE and
NOTICE, which are build specific)
- 1. README - this is usually the first file a user will
read when they download either the source or binary versions of wookie.
- This file usually will not need to be updated very
often, but as it points to other files and explains some of the different
builds, it should be checked for accuracy.
- 2. RELEASE_NOTES - this must be updated with the list
of issues addressed since the last release.
- This can be obtained from the wookie JIRA by selecting
all issues addressed for this planned version.
- 3. UPGRADING - this must be updated if there were any
significant changes made to wookie since the last release.
- Examples of this are - changes to the database which
means that users may have to manually migrate data using scripts
- or where a major overhaul of the user interface OR API
means users would have to change/update their current practices for using those
parts of wookie
- 4. NOTICE - this should be checked to make sure any new
components added to wookie since the last release are mentioned. Note: the
actual licences for these go into the LICENSE file.
- 5. NEW_AND_NOTEWORTHY - this should be checked and
updated to point out and mention any new features in wookie since the last
release, that are deemed significant.
- 6. BUILDING - this describes how to build wookie from
the source. This should be checked for accuracy, but will probably not change
very often.
- 7. LICENSE - this file contains references to all the
licenses of the third party and contributed libaries and code used in wookie.
- Any new libraries and code added since the last release
must have their licences added here. The main exception here is an existing
Apache Software Foundation library, which does not need to be included.
-
- 2. Check the licences and notices found under
/trunk/etc/release/ (Note: some of the builds have specific LICENCE and NOTICE
files)
- 1. /trunk/etc/release/maven/subprojects/LICENCE. This
licence file is bundled with all the maven artifacts
- (except the maven WAR artifact) and should only contain
the apache license. (It is found in in the /META-INF folder of a generated .jar
file)
- 2. /trunk/etc/release/maven/subprojects/NOTICE. This
notice file is bundled with all the maven artifacts
- (except the maven WAR artifact) and should only contain
the apache license references. (It is found in in the /META-INF folder of a
generated .jar file)
- 3. /trunk/etc/release/maven/war/LICENSE. This license
file is bundled with the maven WAR artifact only.
- (It is found in in the /META-INF folder of a generated
.war file).
- 4. /trunk/etc/release/maven/war/NOTICE. This notice
file is bundled with the maven WAR artifact only.
- (It is found in in the /META-INF folder of a generated
.war file).
- 5. /trunk/etc/release/standalone/LICENSE. This license
file is bundled with the standalone build only. (It is found at the root of the
generated standalone build)
- 6. /trunk/etc/release/standalone/NOTICE. This notice
file is bundled with the standalone build only. (It is found at the root of the
generated standalone build)
- 7.
/trunk/etc/release/standalone/STANDALONE_BUILD_NOTES. This should not change
very often, but a quick read through is recommended to make sure nothing has
changed.
- (It is found at the root of the generated standalone
build)
- 8. /trunk/etc/release/war/LICENSE. This license file is
bundled with the war build only. (It is found at the root of the generated war
build)
- 9. /trunk/etc/release/war/NOTICE. This notice file is
bundled with the war build only. (It is found at the root of the generated war
build)
- 10. /trunk/etc/release/war/WAR_BUILD_NOTES. This
should not change very often, but a quick read through is recommended to make
sure nothing has changed.
- (It is found at the root of the generated war build)
-
+ 1. Check the following files found at the root of the trunk. (They are
bundled with all the builds, except in the case of LICENSE and NOTICE, which
are build specific)
+ 1. README - this is usually the first file a user will read when they
download either the source or binary versions of wookie.
+ This file usually will not need to be updated very often, but as it points
to other files and explains some of the different builds, it should be checked
for accuracy.
+ 1. RELEASE_NOTES - this must be updated with the list of issues addressed
since the last release.
+ This can be obtained from the wookie JIRA by selecting all issues
addressed for this planned version.
+ 1. UPGRADING - this must be updated if there were any significant changes
made to wookie since the last release.
+ Examples of this are - changes to the database which means that users may
have to manually migrate data using scripts or where a major overhaul of the
user interface OR API means users would have to change/update their current
practices for using those parts of wookie
+ 1. NOTICE - this should be checked to make sure any new components added
to wookie since the last release are mentioned. Note: the actual licences for
these go into the LICENSE file.
+ 1. NEW_AND_NOTEWORTHY - this should be checked and updated to point out
and mention any new features in wookie since the last release, that are deemed
significant.
+ 1. BUILDING - this describes how to build wookie from the source. This
should be checked for accuracy, but will probably not change very often.
+ 1. LICENSE - this file contains references to all the licenses of the
third party and contributed libaries and code used in wookie.
+ Any new libraries and code added since the last release must have their
licences added here. The main exception here is an existing Apache Software
Foundation library, which does not need to be included.
+
+ 1. Check the licences and notices found under /trunk/etc/release/ (Note:
some of the builds have specific LICENCE and NOTICE files)
+ 1. /trunk/etc/release/maven/subprojects/LICENCE. This licence file is
bundled with all the maven artifacts
+ (except the maven WAR artifact) and should only contain the apache
license. (It is found in in the /META-INF folder of a generated .jar file)
+ 1. /trunk/etc/release/maven/subprojects/NOTICE. This notice file is
bundled with all the maven artifacts
+ (except the maven WAR artifact) and should only contain the apache license
references. (It is found in in the /META-INF folder of a generated .jar file)
+ 1. /trunk/etc/release/maven/war/LICENSE. This license file is bundled with
the maven WAR artifact only.
+ (It is found in in the /META-INF folder of a generated .war file).
+ 1. /trunk/etc/release/maven/war/NOTICE. This notice file is bundled with
the maven WAR artifact only.
+ (It is found in in the /META-INF folder of a generated .war file).
+ 1. /trunk/etc/release/standalone/LICENSE. This license file is bundled
with the standalone build only. (It is found at the root of the generated
standalone build)
+ 1. /trunk/etc/release/standalone/NOTICE. This notice file is bundled with
the standalone build only. (It is found at the root of the generated standalone
build)
+ 1. /trunk/etc/release/standalone/STANDALONE_BUILD_NOTES. This should not
change very often, but a quick read through is recommended to make sure nothing
has changed.
+ (It is found at the root of the generated standalone build)
+ 1. /trunk/etc/release/war/LICENSE. This license file is bundled with the
war build only. (It is found at the root of the generated war build)
+ 1. /trunk/etc/release/war/NOTICE. This notice file is bundled with the war
build only. (It is found at the root of the generated war build)
+ 1. /trunk/etc/release/war/WAR_BUILD_NOTES. This should not change very
often, but a quick read through is recommended to make sure nothing has changed.
+ (It is found at the root of the generated war build)
+
### 4. Check all files for license headers
- Use the [Release Audit Tool
(RAT)](http://ci.apache.org/projects/wookie/rat-output.html) report to find any
missing license headers. Fix any missing entries.
+Use the [Release Audit Tool
(RAT)](http://ci.apache.org/projects/wookie/rat-output.html) report to find any
missing license headers. Fix any missing entries.
### 5. Update all references to SNAPSHOT in the properties files and update
the pom-templates
- 1. Find the version reference '*.*.*-incubating-SNAPSHOT' in the
following files. Update it in each case removing the '-SNAPSHOT' at the end, so
that it reads '*.*.*-incubating'
-
- /build.properties
- /ivy.xml
- /connector/java/build.properties
- /connector/java/ivy.xml
- /modules/jcr/build.properties
- /modules/jcr/ivy.xml
- /parser/java/build.properties
- /parser/java/ivy.xml
- /src/widgetserver.properties
- /etc/release/runsignatures.bat
-
- 2. Update the 3 pom-template.xml files so that the scm values reference
the tag version to be created
-
- /pom-template.xml
-
- Find...
- <scm>
-
<connection>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/trunk</connection>
-
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/trunk/</developerConnection>
- <url>http://svn.apache.org/viewvc/incubator/wookie/trunk/</url>
- </scm>
-
- ...and update it (with correct version number) to read...
-
- <scm>
-
<connection>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/tags/*.*.*-incubating</connection>
-
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/tags/*.*.*-incubating/</developerConnection>
-
<url>http://svn.apache.org/viewvc/incubator/wookie/tags/*.*.*-incubating/</url>
- </scm>
-
- Do the same with the following two files...
-
- /connector/java/pom-template.xml
- /parser/java/pom-template.xml
-
- 3. Commit your changes back to svn.
+ 1. Find the version reference '*.*.*-incubating-SNAPSHOT' in the following
files. Update it in each case removing the '-SNAPSHOT' at the end, so that it
reads '*.*.*-incubating'
+
+ /build.properties
+ /ivy.xml
+ /connector/java/build.properties
+ /connector/java/ivy.xml
+ /modules/jcr/build.properties
+ /modules/jcr/ivy.xml
+ /parser/java/build.properties
+ /parser/java/ivy.xml
+ /src/widgetserver.properties
+ /etc/release/runsignatures.bat
+
+ 2. Update the 3 pom-template.xml files so that the scm values reference the
tag version to be created
+
+ /pom-template.xml
+
+ Find...
+ <scm>
+
<connection>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/trunk</connection>
+
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/trunk/</developerConnection>
+ <url>http://svn.apache.org/viewvc/incubator/wookie/trunk/</url>
+ </scm>
+
+ ...and update it (with correct version number) to read...
+
+ <scm>
+
<connection>scm:svn:http://svn.apache.org/repos/asf/incubator/wookie/tags/*.*.*-incubating</connection>
+
<developerConnection>scm:svn:https://svn.apache.org/repos/asf/incubator/wookie/tags/*.*.*-incubating/</developerConnection>
+
<url>http://svn.apache.org/viewvc/incubator/wookie/tags/*.*.*-incubating/</url>
+ </scm>
+
+ Do the same with the following two files...
+
+ /connector/java/pom-template.xml
+ /parser/java/pom-template.xml
+
+ 3. Commit your changes back to svn.
### 6. Inform committers of temporary code freeze
