db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Db-derby Wiki] Update of "TmpDerbySnapshotOrRelease" by MyrnavanLunteren
Date Fri, 27 Jul 2007 04:22:01 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Db-derby Wiki" for change notification.

The following page has been changed by MyrnavanLunteren:
http://wiki.apache.org/db-derby/TmpDerbySnapshotOrRelease

------------------------------------------------------------------------------
  Temporary wiki page to work on Restructuring the instructions - see DERBY-2575.
+ '''Table of Contents'''
+ [[TableOfContents(3)]]
+ 
+ 
+ 
+ Temporary wiki page to work on Restructuring the instructions - see DERBY-2575.
  
  
  == Releases ==
  
+ 
+ === high level time line ===
+ once before release:
+   - volunteer for release manager
+   - create wiki pages (main, buddytesting, platform testing, app testing) for release
+   - (optional:) create branch
+   - ensure you have all required tools and files
+   - ensure your KEYS are in place, and signed
+   - create packaging.properties based on packaging.tmpl
+   - create buddytesting page and troll for buddies 
+ for each release candidate
+   - ensure all new files have correct copyright & license
+   - arrange for appropriate version numbers in JIRA
+   - svn update source and doc trees
+   - add new section to testing wiki pages
+   - drive bug list to zero
+   - update release.properties
+   - create maintversion.properties
+   - update masters (ant regex) and test
+   - ensure all release notes are current
+   - copy rrefexcept.dita from <source>/classes/doc to <docsource>/src/ref
+   - update releaseSummary.xml, create release notes & changes files
+   - clean doc & source trees, build release artifacts
+   - (optional:) build eclipse plugin
+   - sign and place on people.apache.org web site
+   - verify a downloaded lib, bin and src distribution (build in the src distribution, preferably
create a release). 
+   - bump version 
+   - update release wiki page
+   - call for vote
+ once after candidate passes vote
+   - tally vote & announce
+   - put files on mirrors
+   - create web page for release
+   - update STATUS file
+   - deploy to maven repository
+ 
  === communicate with the community ===
+ 
+ The following are the communication tasks the release manager has to take care of:
+ 
   1. Announce your intention/desire to have a release on the list
  
-   As new features are added and bugs fixed, it is likely that someone will announce their
intention to produce a release (if they are a committer) and volunteer to be the release manager.
It may also be the case that a non-committer will ask when the next official release will
occur. This should be a sign to committers that there is demand for a release. :)
+   As new features are added and bugs fixed, it is likely that someone will announce their
intention to produce a 
+ 
+ release (if they are a committer) and volunteer to be the release manager. It may also be
the case that a non-
+ 
+ committer will ask when the next official release will occur. This should be a sign to committers
that there is 
+ 
+ demand for a release. :)
  
   1. Volunteer as release manager (or try to enlist one)
  
-   Since only committers have the necessary access to Apache resources to shepherd a release
to its completion, a committer must volunteer to be the release manager. Usually (hopefully)
someone will volunteer if it is clear there is demand for a release. A release manager is
under no obligation to finish once they volunteer, and another committer can pick up and complete
their work, or even produce a competing release if so desired.
+   Since only committers have the necessary access to Apache resources to shepherd a release
to its completion, a 
+ 
+ committer must volunteer to be the release manager. Usually (hopefully) someone will volunteer
if it is clear there 
+ 
+ is demand for a release. A release manager is under no obligation to finish once they volunteer,
and another 
+ 
+ committer can pick up and complete their work, or even produce a competing release if so
desired.
+ 
+  1. Make a wiki page for the release. 
+ 
+ On it, identify timeframes, and let the community identify items for special mention (or
do this yourself). Also 
+ 
+ prepare a place to gather testing information (for instance, use a previous' release's wiki
pages as a starting 
+ 
+ point).
+ 
+  1. Arrange for appropriate version numbers in JIRA
+ 
+ The JIRA administrators will need to do this. This is a little more tricky than it seems;
You have to decide what 
+ 
+ the release is going to be called, and it ties in with the technical part of where the release
info is coming from 
+ 
+ in the code (essentially, <branch/trunk>/tools/ant/properties/release.properties).
Note, if you need to make a 
+ 
+ branch, that the first release off the branch will report 'beta', no matter what the 'beta'
flag in 
+ 
+ release.properties says. A release candidate should not have the 'beta' flag.
+ 
+  1. Drive the bug list to zero
+ 
+ Communicate with the community about which bugs need to get fixed, which bugs need release
notes, and what else 
+ 
+ needs to be in the release notes. 
+ 
+  1. Address items on the ReleaseVettingChecklist
+ 
+   Make sure that the community addresses relevant items on the ReleaseVettingChecklist.
  
   1. Vote on the distributions
  
-   Call for a vote on derby-dev to have the distributions posted on your public_html accepted
for the release. A vote needs to be running for at least 7 days, so, give at least that much
time before closing the vote to give adequate time for others to inspect and test the distributions.
If no-one has responded after a week, prod gently until you get a response. A majority of
votes, and at least one binding +1 vote are required for acceptance.
+   Call for a vote on derby-dev to have the distributions posted on your public_html accepted
for the release. A vote 
  
-   Forward or bcc a copy of the call for vote to private@db.apache.org so the DB PMC is aware
that a vote is in progress. Also forward the results post to private@db.apache.org. (Note:
do not '''cc''' the PMC; '''bcc''' or forward a copy of the post.)
+ needs to be running for at least 7 days, so, give at least that much time before closing
the vote to give adequate 
  
-  1. Address items on the ReleaseVettingChecklist
+ time for others to inspect and test the distributions. If no-one has responded after a week,
prod gently until you 
  
-   Make sure that the community addresses relevant items on the ReleaseVettingChecklist.
+ get a response. A majority of votes, and at least three binding +1 vote are required for
acceptance.
  
+   Forward or bcc a copy of the call for vote to private@db.apache.org so the DB PMC is aware
that a vote is in 
+ 
+ progress. Also forward the results post to private@db.apache.org. (Note: do not '''cc'''
the PMC; '''bcc''' or 
+ 
+ forward a copy of the post.)
+ 
-  1. If vote does not pass and go back to 'Drive bug list to zero'.
+  1. If vote does not pass go back to 'Drive bug list to zero'.
  
-   If the vote does not pass and additional release candidates need to be made, then presumably
it won't have passed because of a showstopper-type bug or similar issue. So, go back to the
bug-fixing section.
+   If the vote does not pass and additional release candidates need to be made, then presumably
it won't have passed 
+ 
+ because of a showstopper-type bug or similar issue. So, go back to the bug-fixing section.
  
  
  
  === herding bugs, changes, fixes, release notes ===
  
+ The release manager needs to do the following tasks with JIRA:
+ 
   1. Target the bugs you feel should be fixed in JIRA
  
    All features and bug fixes should be tracked in JIRA: http://issues.apache.org/jira/browse/DERBY
-   Mark the Fix In field for the JIRA entries for the items you want to be in the release
with the proper version. Also, it's a good idea to post to derby-dev to get an idea of what
features or fixes other contributors would like in the release.
+   Mark the Fix In field for the JIRA entries for the items you (and/or the community) want
to be in the release with 
+ 
+ the proper version. Also, it's a good idea to post to derby-dev to get an idea of what features
or fixes other 
+ 
+ contributors would like in the release.
  
   1. Fix the bugs, update STATUS and CHANGES/RELEASE_NOTES.html as needed
  
-   Get to work! Add features, fix bugs, and update STATUS as you go. The wiki is nice, as
are personal webpages, but STATUS is the designated place for Apache projects to keep their
current status. Apache members and committers expect to be able to grab the STATUS file from
the code tree to determine the current status of the project. It's a nice thing to keep the
STATUS file on branches up to date with the current status of the branch. The other essential
document is a document describing the changes. Derby branches up to 10.2 included a file 'CHANGES'
for that purpose; 10.3 branch and trunk have a RELEASE_NOTES.html checked in. RELEASE_NOTES.html
is generated using the generator in <10.3 branch and up/trunk>/java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java.
+   Get to work! Add features, fix bugs, and update STATUS as you go. The wiki is nice, as
are personal webpages, but 
+ 
+ STATUS is the designated place for Apache projects to keep their current status. Apache
members and committers 
+ 
+ expect to be able to grab the STATUS file from the code tree to determine the current status
of the project. It's a 
+ 
+ nice thing to keep the STATUS file on branches up to date with the current status of the
branch. The other essential 
+ 
+ document is a document describing the changes. Derby branches up to 10.2 included a file
'CHANGES' for that purpose; 
+ 
+ 10.3 branch and trunk have a RELEASE_NOTES.html checked in, as well as CHANGES.html. RELEASE_NOTES.html
is generated 
+ 
+ using the generator in <10.3 branch and up/trunk>/java/build/org/apache/derbyBuild/ReleaseNotesGenerator.java,
which 
+ 
+ is activated by executing ant genrelnotes in tools/release. 
  
   1. Drive the bug list to zero.
  
-   As the list of remaining bugs in JIRA approaches zero, be sure to mark their status properly
in JIRA. Mark blocker and critical bugs as such so that others can see the status at a glance.
Move non-showstopper bugs out to future releases if it appears they will not be fixed for
this release.
+   As the list of remaining bugs in JIRA approaches zero, be sure to mark their status properly
in JIRA. Mark blocker 
+ 
+ and critical bugs as such so that others can see the status at a glance. Move non-showstopper
bugs out to future 
+ 
+ releases if it appears they will not be fixed for this release.
  
   1. Drive the creation of release notes.
    The release note generator expects files called 'ReleaseNote.html' for each item marked
that is:
@@ -51, +170 @@

      - fixed in the release under study but not in the previous release
      - marked with 'Existing Application Impact' or 'Release Note Needed'.
  
-  1. Check that all creative works have ASF license headers. See: [http://wiki.apache.org/db-derby/FixingLicenseHeader].
Also ensure that the year in NOTICE is correct. Similarly, ensure that all versions and copyright
details in the docs tree are correct, this includes the top level conrefs.dita, as well as
lower level dita files.
  
+ === prepare the source for building the release ===
- 
- === prepare your machine/environment for building the release artifacts ===
-  1. Make sure your public PGP/GPG key is in the KEYS file
- 
-   For information about PGP and why it is used to sign release binaries at Apache, please
read [http://people.apache.org/~henkp/trust/].
- 
-   You should create a PGP key for yourself if you do not have one, and upload it to at least
one, preferably two, of the main public keyservers, e.g. pgp.mit.edu. You will need this key
to sign the release binaries. Ideally, your key should be tied into the Apache web of trust.
- 
-   GPG is available for a variety of platforms from http://gnupg.org. PGP is a commercial
product which is available from http://pgp.com.
  
   1. For major releases, create a new branch for the release, in both the code and docs trees.
  
+   {{{svn copy -r {rev} https://svn.apache.org/repos/asf/db/derby/code/trunk/ 
-   {{{svn copy -r {rev} https://svn.apache.org/repos/asf/db/derby/code/trunk/ https://svn.apache.org/repos/asf/db/derby/code/branches/{branchname}/
- svn copy -r {rev} https://svn.apache.org/repos/asf/db/derby/docs/trunk/ https://svn.apache.org/repos/asf/db/derby/docs/branches/{branchname}/}}}
  
-   There is not currently a target for bumping the version number on the trunk. You should
edit release.properties by hand to bump the major/minor properties as appropriate, zero out
the maint property, and ensure the beta flag is set to true. Then, from the top, run:
+ https://svn.apache.org/repos/asf/db/derby/code/branches/{branchname}/
+ svn copy -r {rev} https://svn.apache.org/repos/asf/db/derby/docs/trunk/ 
  
+ https://svn.apache.org/repos/asf/db/derby/docs/branches/{branchname}/}}}
+ 
+   After creating the branch, bump the version number on the trunk. There is not currently
an ant target for bumping 
+ 
+ the version number on the trunk. You should edit release.properties on trunk by hand to
bump the major/minor 
+ 
+ properties as appropriate, zero out the maint property, and ensure the beta flag is set
to true. Then, from the top, 
+ 
+ run:
+ 
-   {{{java org.apache.derbyBuild.maintversion2props tools/ant/properties/release.properties
tools/release/maintversion.properties}}}
+   {{{java org.apache.derbyBuild.maintversion2props tools/ant/properties/release.properties

+ 
+ tools/release/maintversion.properties}}}
    {{{cd tools/release
  ant regex.masters}}}
  
-   If you ended up creating a branch, add the new branch number to the list of Branches on
the downloads page of the website. For pointers on how to edit the downloads page, see the
"Update the website" section above in the Snapshot instructions.
+   Add the new branch number to the list of Branches on the source page of the website. For
pointers on how to 
  
-   See TODO in #8 for caveat concerning the beta flag. Don't forget to post to derby-dev
requesting that a new version be added to JIRA for the next version of Derby.
+ edit the downloads page, see the "Update the website" section below in the Snapshot instructions.
The actual page to modify is src\documentation\content\xdocs\dev\derby_source.xml.
+   Note: the regex.masters target does not currently account for changes in the beta flag.
Run the tests to make sure 
  
-  1. Bump the third version number, adjust the beta flag, finalize CHANGES, and check in
the new version and test masters. You will need to clobber and build to see the changed release
number(s) reflected in the source. Note that the first release off a new branch is automatically
beta, even if you set the beta flag in tools/ant/properties/release.properties to false. Also
adjust version numbers in documentation by modifying the appropriate *conrefs.dita files.
+ the output files are correct. Don't forget to post to derby-dev requesting that a new version
be added to JIRA for 
  
-   There is not currently an ant target for bumping the third version number. The third and
fourth parts of the version are combined into a single property, maint, where maint = (third
digit * 1000000) + fourth digit. Also, if this is a major/minor (feature) release, you should
remove the beta flag at this time. You should update tools/ant/properties/release.properties
by hand and then run:
+ the next version of Derby.
  
+  1. Make sure your public PGP/GPG key is in the KEYS file
+ 
+   For information about PGP and why it is used to sign release binaries at Apache, please
read 
+ 
+ [http://people.apache.org/~henkp/trust/].
+ 
+   You should create a PGP key for yourself if you do not have one, and upload it to at least
one, preferably two, of 
+ 
+ the main public keyservers, e.g. pgp.mit.edu. You will need this key to sign the release
binaries. Your key should 
+ 
+ be tied into the Apache web of trust, which means you should have at least one person sign
your key, and you should 
+ 
+ have done gpg --refresh-keys to get that person's signature before you follow the steps
at the top of the KEYS file.
+ 
+   GPG is available for a variety of platforms from http://gnupg.org. PGP is a commercial
product which is available 
+ 
+ from http://pgp.com.
+ 
+   Your KEY needs to be in the KEYS file in trunk, KEYS file on the branch if you've created
one, and the KEYS file 
+ 
+ in /www/www.apache.org/dist/db/derby at people.apache.org.
+ 
+  1. Check that all creative works have ASF license headers. See: [http://wiki.apache.org/db-
+ 
+ derby/FixingLicenseHeader]. Also ensure that the year in NOTICE is correct. Similarly, ensure
that all versions and 
+ 
+ copyright details in the docs tree are correct, this includes the top level conrefs.dita,
as well as lower level 
+ 
+ dita files.
+ 
+ === prepare for the release management task ===
+ 
+ To be able to produce the release artifacts, you need to
+ - update version numbers and run tests to verify it was correct
+ - generate release notes and changes.html
+ - build all in doc and source objects (except for eclipse ui and doc plugins, those are
optional)
+ - sign 
+ - verify
+ - modify derby web
+ - distribute to maven
+ 
+ This means you have to have to be able to do the following / use the following tools:
+ - md5 
+ - pgp (see: )
+ - ant (see BUILDING.txt)
+ - dita (see:  )
+ - forrest (see:  )
+ - eclipse (optional)
+ 
+ And you have to have the following files available:
+ - osgi.jar (see BUILDING.txt)
+ - j2me implementation (see BUILDING.txt)
+ - jdk16 implementaion (see BUILDING.txt)
+ - junit.jar (see BUILDING.txt)
+ - ditazip (see: )
+ 
+ You need to at least have the doc tree and source tree available, and your ant.properties
file needs to
+ include:
+ j14lib=<location of jdk14(2)/jre/lib>
+ jdk16=<location of jdk16>
+ jsr169compile.classpath=<location of jsr169 implementation>
+ junit=<location of junit.jar>
+ build.compiler=<modern, or see BUILDING.txt for other options>
+ proceed=true
+ relnotes.src.reports=<location where you want to save/access the xml scripts for generating
release notes>
+ #sane=<sane should *not* be set>
+ 
+ 
+ special consideration for windows users:
+ - ant sign, the last step in the ant release process, may not work.
+   try it out before the release time is there; if you cannot do this, you may achieve the
same using
+   the following script
+ 
+ - similarly, you may use a script to verify the release
+ 
+ - your md5 tool may be different.
+   you'll need to copy the file packaging.tmpl to packaging.properties and adjust it appropriately.
+   
+ 
+ 
+ === prepare your machine/environment for building the release artifacts ===
+ 
+  1. Bump the third version number, adjust the beta flag, finalize CHANGES, and RELEASE-NOTES
and check in the new 
+ 
+ version and test masters. You will need to clobber and build to before you can see the changed
release number(s) 
+ 
+ reflected in the source. Note that the first release off a new branch is automatically beta,
even if you set the 
+ 
+ beta flag in tools/ant/properties/release.properties to false. Also adjust version numbers
in documentation by 
+ 
+ modifying the appropriate *conrefs.dita files.
+ 
+   There is not currently an ant target for bumping the third version number. The third and
fourth parts of the 
+ 
+ version are combined into a single property, maint, where maint = (third digit * 1000000)
+ fourth digit. Also, if 
+ 
+ this is a major/minor (feature) release, you should remove the beta flag at this time. You
should update 
+ 
+ tools/ant/properties/release.properties by hand and then run:
+ 
-   {{{java org.apache.derbyBuild.maintversion2props tools/ant/properties/release.properties
tools/release/maintversion.properties}}}
+   {{{java org.apache.derbyBuild.maintversion2props tools/ant/properties/release.properties

+ 
+ tools/release/maintversion.properties}}}
    {{{cd tools/release
  ant regex.masters}}}
  
@@ -94, +319 @@

  
   1. Sync the repository.
  
-   'svn up' in your subversion view to bring all files in your view up to the latest revision.
Otherwise, the version output by svn which is captured for the build number will be a range
(e.g. 290275:320938).
+   'svn up' in your subversion view to bring all files in your view up to the latest revision.
Otherwise, the version 
+ 
+ output by svn which is captured for the build number will be a range (e.g. 290275:320938).
+ 
+ 
+ 
+  1. Check in the latest SQLState documentation.
+ 
+   The SQLStates are documented in the Reference Guide on the following page: rrefexcept71493.dita.
This file is 
+ 
+ generated by the Derby build and placed in classes/doc. Take the version of this file generated
by building the code 
+ 
+ branch and check it into the doc branch at src/ref/rrefexcept71493.dita.
+ 
+  1. Make sure you have the doc tree checked out, and a clean copy of the source checkout.
+ 
  
   1. Make sure your build will build all of the optional components.
  
@@ -104, +344 @@

    * The OSGi support
    * The JSR169 support
  
- 
-  1. Check in the latest SQLState documentation.
- 
-   The SQLStates are documented in the Reference Guide on the following page: rrefexcept71493.dita.
This file is generated by the Derby build and placed in classes/doc. Take the version of this
file generated by building the code branch and check it into the doc branch at src/ref/rrefexcept71493.dita.
- 
   1. Build the documentation.
  
-   The documentation needs to be included in the -bin distribution and src, so you will need
to access the doc branch when running the ant release target. Information on building the
docs is located at [http://db.apache.org/derby/manuals/dita.html]. 
+   The documentation needs to be included in the -bin distribution and src, so you will need
to access the doc branch 
+ 
+ when running the ant release target. Information on building the docs is located at 
+ 
+ [http://db.apache.org/derby/manuals/dita.html]. 
  
   1. Copy packaging.tmpl to packaging.properties in tools/release and modify as necessary.
  
-   Once you have a copy of the documentation on your local machine, you will need to update
the property ${docs.out} in tools/ant/properties/packaging.properties to point to your local
copy of the documentation. Check that the settings in tools/ant/properties/packaging.properties
are correct for your md5 hash tool and pgp/gpg tool and then go to the next step.
+   Once you have a copy of the documentation on your local machine, you will need to update
the property ${docs.out} 
  
-   Most Unix distributions come with either md5 or md5sum. An md5sum utility for Windows
can be downloaded as a part of the !GnuWin32 port of the core Gnu utilities, from: http://gnuwin32.sourceforge.net/packages/coreutils.htm.
A standalone md5 utility can be found at http://www.fourmilab.ch/md5/. Note for the executable
available from this last location, the correct option for output is md5 -n.
+ in tools/ant/properties/packaging.properties to point to your local copy of the documentation.
Check that the 
+ 
+ settings in tools/ant/properties/packaging.properties are correct for your md5 hash tool
and pgp/gpg tool and then 
+ 
+ go to the next step.
+ 
+   Most Unix distributions come with either md5 or md5sum. An md5sum utility for Windows
can be downloaded as a part 
+ 
+ of the !GnuWin32 port of the core Gnu utilities, from: http://gnuwin32.sourceforge.net/packages/coreutils.htm.
A 
+ 
+ standalone md5 utility can be found at http://www.fourmilab.ch/md5/. Note for the executable
available from this 
+ 
+ last location, the correct option for output is md5 -n.
  
   1. Create the release distributions and checksums, sign the distributions
  
-   Check your classpath for osgi.jar for OSGI support and make sure jsr169compile.classpath
is set for J2ME support. For 10.2 forward, make sure that you have JDK 1.6 available and that
you've set the jdk16 property to the JAVA_HOME for your JDK 1.6 installation in your ant.properties
so that the JDBC 4.0 classes are built and the JDBC 4.0 javadoc is created. If you have the
sane property set in your ant.properties, remove it at this time to prevent it from overriding
the false setting passed into the snapshot target.
+   Check your classpath for osgi.jar for OSGI support and make sure jsr169compile.classpath
is set for J2ME support. 
+ 
+ For 10.2 forward, make sure that you have JDK 1.6 available and that you've set the jdk16
property to the JAVA_HOME 
+ 
+ for your JDK 1.6 installation in your ant.properties so that the JDBC 4.0 classes are built
and the JDBC 4.0 javadoc 
+ 
+ is created. If you have the sane property set in your ant.properties, remove it at this
time to prevent it from 
+ 
+ overriding the false setting passed into the snapshot target.
  
  === building the release artifacts ===
  
@@ -141, +400 @@

  ant release
  ant sign}}}
  
-     You will need to enter your PGP passphrase several times as the release distributions
are signed. This will create the following files in your tools/release directory:
+     You will need to enter your PGP passphrase several times as the release distributions
are signed. This will 
+ 
+ create the following files in your tools/release directory:
  
    *db-derby-[version]-bin.tar.gz
    *db-derby-[version]-bin.zip
@@ -152, +413 @@

    *db-derby-[version]-src.tar.gz
    *db-derby-[version]-src.zip
  
-   The Eclipse core plugin is generated in the snapshot directory at the top level by the
snapshot target. You should also create the Eclipse UI plugins (see plugins/eclipse/readme.txt,
except use the core plugin created in the snapshot), but this requires Eclipse. If you don't
want to do it yourself, those interested in the Eclipse plugins will likely volunteer to generate
them for you. You should also create checksums and signatures for these files with:
+   The Eclipse core plugin is generated in the snapshot directory at the top level by the
snapshot target. You should 
+ 
+ also create the Eclipse UI plugins (see plugins/eclipse/readme.txt, except use the core
plugin created in the 
+ 
+ snapshot), but this requires Eclipse. If you don't want to do it yourself, those interested
in the Eclipse plugins 
+ 
+ will likely volunteer to generate them for you. You should also create checksums and signatures
for these files 
+ 
+ with:
  
    {{{gpg --armor --detach-sign derby_ui_plugin_[version].zip
  gpg --armor --detach-sign derby_core_plugin_[version].zip
  md5 -q derby_ui_plugin_[version].zip > derby_ui_plugin_[version].zip.md5
  md5 -q derby_core_plugin_[version].zip > derby_core_plugin_[version].zip.md5}}}
  
-   There is a problem with the Ant 'sign' target on Cygwin that may occur elsewhere. If for
some reason the Ant 'sign' target hangs, it may be prompting and waiting for input that you
cannot see. In that case, you can also use this simple script to automate signing the release
archives:
+   There is a problem with the Ant 'sign' target on Cygwin that may occur elsewhere. If for
some reason the Ant 
+ 
+ 'sign' target hangs, it may be prompting and waiting for input that you cannot see. In that
case, you can also use 
+ 
+ this simple script to automate signing the release archives:
  
    {{{#!/bin/sh
  
@@ -177, +450 @@

  signone $1-src.tar.gz
  signone $1-src.zip}}}
  
-   Invoking this 'sign.sh db-derby-10.1.1.0' would sign all of the release archives for Derby
10.1.1.0, for example. Be sure to replace the commands for gpg and md5 with the correct commands
for your system. Note that on cygwin, the md5 switch is "-n" rather than "-q".
+   Invoking this 'sign.sh db-derby-10.1.1.0' would sign all of the release archives for Derby
10.1.1.0, for example. 
+ 
+ Be sure to replace the commands for gpg and md5 with the correct commands for your system.
Note that on cygwin, the 
+ 
+ md5 switch is "-n" rather than "-q".
  
   1. Verify the signatures and checksums.
  
@@ -206, +483 @@

  
   1. Post the distributions
  
-   Copy the files from tools/release to your public_html directory on people.apache.org.
Post to derby-dev so that others can begin testing.
+   Copy the files from tools/release to your public_html directory on people.apache.org.
Post to derby-dev so that 
  
+ others can begin testing.
  
+ 
- === publicise new release ===
+ === publish new release ===
  
   1. If the vote passes, put distributions onto mirrors
  
@@ -218, +497 @@

    http://www.apache.org/dev/mirrors.html and
    http://www.apache.org/dev/mirror-step-by-step.html
  
-   Copy the distribution archives and their signatures/checksums to a new directory underneath
/www/www.apache.org/dist/db/derby on people.apache.org.
+   Copy the distribution archives and their signatures/checksums to a new directory underneath

  
+ /www/www.apache.org/dist/db/derby on people.apache.org.
+ 
-   If the new release is the most current release, link the -current links to the new files.
Here's a quick-and-dirty shell script for doing so:
+   If the new release is the most current release, link the -current links to the new files.
Here's a quick-and-dirty 
+ 
+ shell script for doing so:
  
    {{{ln -s $1/$1-bin.tar.gz db-derby-current-bin.tar.gz
  ln -s $1/$1-bin.tar.gz.asc db-derby-current-bin.tar.gz.asc
@@ -242, +525 @@

  
    using db-derby-10.1.1.0 as the release to link to -current as an example.
  
-   If this release supercedes a previous release on a branch, be sure to move the old files
to the archive. It is important that we keep our mirror directory tidy.
+   If this release supercedes a previous release on a branch, be sure to move the old files
to the archive. It is 
+ 
+ important that we keep our mirror directory tidy.
  
    You should also make sure that your public PGP key is in the KEYS file at /www/www.apache.org/dist/db/derby/KEYS
  
   1. Create a page for the release, build/update site
  
-   For instructions on how to build the website, see item 3 regarding snapshots above. It
is a good idea to use the previous release pages as templates, filling in the changed details
as necessary. You should add a .cgi and a .html file for the release. The main thing to remember
is that the .cgi file should have the same name as the .html file. Also, when you run 'svn
up' on people.apache.org (3e above), make sure that the new .cgi file is executable and otherwise
has the correct permissions!
+   For instructions on how to build the website, see item 3 regarding snapshots below. It
is a good idea to use the 
+ 
+ previous release pages as templates, filling in the changed details as necessary. You should
add a .cgi and a .html 
+ 
+ file for the release. The main thing to remember is that the .cgi file should have the same
name as the .html file. 
+ 
+ Also, when you run 'svn up' on people.apache.org (3e above), make sure that the new .cgi
file is executable and 
+ 
+ otherwise has the correct permissions!
  
    Note the following things when creating the release page:
-   * Be sure to specify that the src.tar.gz requires gnu tar to unravel (because of our usage
of ant tar to create this, using longfile=gnu for handling long filenames).
+   * Be sure to specify that the src.tar.gz requires gnu tar to unravel (because of our usage
of ant tar to create 
+ 
+ this, using longfile=gnu for handling long filenames).
-   * Forrest will not copy the release .cgi script over unless you make a link to it from
another page. Add the link to derby_downloads.html before building.
+   * Forrest will not copy the release .cgi script over unless you make a link to it from
another page. Add the link 
-   * Make sure that the .cgi script is made executable by setting svn:executable on it with
{{{svn propset svn:executable ON release-10.1.2.1.cgi}}}. Be sure to do this for both the
precursor version you created in src/documentation/content/xdocs/releases and for the generated
copy which forrest builds into build/site/releases.
-   * In order for the release HTML file to be pulled into the build, it is necessary to add
a line to the <uris> section of src/documentation/conf/cli.xconf. Near line 310 of that
file, add: <uri type="append" src="releases/release-10.1.2.1.html"/> (with the correct
version for your release)
+ 
+ to derby_downloads.html before building.
+   * Make sure that the .cgi script is made executable by setting svn:executable on it with
{{{svn propset 
+ 
+ svn:executable ON release-10.1.2.1.cgi}}}. Be sure to do this for both the precursor version
you created in 
+ 
+ src/documentation/content/xdocs/releases and for the generated copy which forrest builds
into build/site/releases.
+   * In order for the release HTML file to be pulled into the build, it is necessary to add
a line to the <uris> 
+ 
+ section of src/documentation/conf/cli.xconf. Near line 310 of that file, add: <uri type="append"

+ 
+ src="releases/release-10.1.2.1.html"/> (with the correct version for your release)
-   * Due to [http://issues.apache.org/jira/browse/FOR-480]FOR-480, the release page will
be built into your $FORREST_HOME/main/site directory.
+   * Due to [http://issues.apache.org/jira/browse/FOR-480]FOR-480, the release page will
be built into your 
-   * Due to [http://issues.apache.org/jira/browse/FOR-555]FOR-555, the HTML comments which
constitute the form template into which the mirrors.cgi script splices in the mirror information
will be removed by Forrest. It is necessary to add these comments back in to the release page
before committing or letting the site go live on people.apache.org.
-   * Subversion may report some files as changed which should be static. Revert anything
in build/site/skin or build/site/papers before committing your website changes ([http://db.apache.org/derby/papers/derby_web.html#odd_diffs
see the explanation]).
-   * Once you have committed your changes and updated the website on people, you can preview
your changes by following the instructions at http://www.apache.org/dev/project-site.html
+ 
+ $FORREST_HOME/main/site directory.
+   * Due to [http://issues.apache.org/jira/browse/FOR-555]FOR-555, the HTML comments which
constitute the form 
+ 
+ template into which the mirrors.cgi script splices in the mirror information will be removed
by Forrest. It is 
+ 
+ necessary to add these comments back in to the release page before committing or letting
the site go live on 
+ 
+ people.apache.org.
+   * Subversion may report some files as changed which should be static. Revert anything
in build/site/skin or 
+ 
+ build/site/papers before committing your website changes 
+ 
+ ([http://db.apache.org/derby/papers/derby_web.html#odd_diffs see the explanation]).
+   * Once you have committed your changes and updated the website on people, you can preview
your changes by 
+ 
+ following the instructions at http://www.apache.org/dev/project-site.html
  
   1. Deploy to Maven repository.
  
-   First, if you do not already have the latest Maven 1 distribution, download it from http://maven.apache.org/maven-1.x/start/download.html,
unpack it, and put the bin directory into your path so that you can run maven commands. As
of this writing, the latest 1.x version of Maven was 1.0.2.
+   First, if you do not already have the latest Maven 1 distribution, download it from http://maven.apache.org/maven
  
-   Next, edit project.xml in the maven directory in the derby tree to contain the correct
version number for this release between the <currentversion> tags. Then, edit the project.properties
to contain the correct protocol, username, and password for your account on people.apache.org
so you can properly authenticate and copy the files to people. The scpexe protocol should
work without problems, especially if you have an ssh public key already on people. The project.properties
file in the maven directory should look something like this, for the maven.repo lines in the
file:
+ -1.x/start/download.html, unpack it, and put the bin directory into your path so that you
can run maven commands. As 
+ 
+ of this writing, the latest 1.x version of Maven was 1.0.2.
+ 
+   Next, edit project.xml in the maven directory in the derby tree to contain the correct
version number for this 
+ 
+ release between the <currentversion> tags. Then, edit the project.properties to contain
the correct protocol, 
+ 
+ username, and password for your account on people.apache.org so you can properly authenticate
and copy the files to 
+ 
+ people. The scpexe protocol should work without problems, especially if you have an ssh
public key already on 
+ 
+ people. The project.properties file in the maven directory should look something like this,
for the maven.repo lines 
+ 
+ in the file:
  
    {{{maven.repo.list=apache
  maven.repo.apache=scpexe://people.apache.org
@@ -273, +606 @@

  maven.repo.apache.password={your_password}
  maven.repo.apache.group=db}}}
  
-   Also, make sure you have the maven artifact plugin, version 1.5.2, so that maven generates
SHA1 checksums for the files you upload, by running the following command:
+   Also, make sure you have the maven artifact plugin, version 1.5.2, so that maven generates
SHA1 checksums for the 
+ 
+ files you upload, by running the following command:
  
    {{{maven plugin:download -DgroupId=maven \
    -DartifactId=maven-artifact-plugin \
    -Dversion=1.5.2}}}
  
-   NOTE: this should only be necessary for Maven 1.0.2. The latest artifact plugin will be
included in future stable releases of Maven 1.x.
+   NOTE: this should only be necessary for Maven 1.0.2. The latest artifact plugin will be
included in future stable 
+ 
+ releases of Maven 1.x.
  
    Then, cd into Derby's maven directory and
  
@@ -287, +624 @@

  
     $ maven clean   # will attain the multiproject:clean goal to clean up the maven tree
  
-    $ maven multiproject:deploy   # will copy all the artifacts into the apachecvs repository
(note, for now this this has been disabled by commenting out the maven.repo.list definition
in project.properties).
+    $ maven multiproject:deploy   # will copy all the artifacts into the apachecvs repository
(note, for now this 
+ 
+ this has been disabled by commenting out the maven.repo.list definition in project.properties).
  
    This does not build using maven, it works by copying the jars that ant built into jars/${sanity}.
  
-   After successfully deploying the jars to the maven repository on minotaur, you may receive
an email that you did not upload appropriate PGP signatures for the new files added to www.apache.org/dist/.
To prevent receiving this mail, you will need to sign the individual jars and then upload
the signatures to /www/people.apache.org/repo/m1-ibiblio-rsync-repository/org.apache.derby/jars
after running maven's multiproject:deploy target. The following script signs and renames the
jars appropriately, and should be run in the jars/insane directory.
+   After successfully deploying the jars to the maven repository on minotaur, you may receive
an email that you did 
+ 
+ not upload appropriate PGP signatures for the new files added to www.apache.org/dist/. To
prevent receiving this 
+ 
+ mail, you will need to sign the individual jars and then upload the signatures to /www/people.apache.org/repo/m1-
+ 
+ ibiblio-rsync-repository/org.apache.derby/jars after running maven's multiproject:deploy
target. The following 
+ 
+ script signs and renames the jars appropriately, and should be run in the jars/insane directory.
  
    {{{for i in *.jar
  do
@@ -310, +657 @@

  cd /www/people.apache.org/repo/m1-ibiblio-rsync-repository/org.apache.derby/jars/
  put *.jar.asc}}}
  
-   The deployment of the jars and poms to the Maven 1 repository will be automatically converted
to appropriate jars and poms for Maven 2 and deployed to that repository as well. See [http://issues.apache.org/jira/browse/DERBY-1378
DERBY-1378] for more information on the automatic conversion to Maven 2.
+   The deployment of the jars and poms to the Maven 1 repository will be automatically converted
to appropriate jars 
  
-   Maven may not work for you. If Maven does not copy the build artifacts to subdirectories
under /www/people.apache.org/repo/m1-ibiblio-rsync-repository/org.apache.derby/, then you
will have to do this yourself. In this scenario, you must use Maven to deploy the build artifacts
to your local file system and then sftp the results to people.apache.org. To deploy the build
artifacts to your local file system, set up project.properties something like this:
+ and poms for Maven 2 and deployed to that repository as well. See [http://issues.apache.org/jira/browse/DERBY-1378

+ 
+ DERBY-1378] for more information on the automatic conversion to Maven 2.
+ 
+   Maven may not work for you. If Maven does not copy the build artifacts to subdirectories
under 
+ 
+ /www/people.apache.org/repo/m1-ibiblio-rsync-repository/org.apache.derby/, then you will
have to do this yourself. 
+ 
+ In this scenario, you must use Maven to deploy the build artifacts to your local file system
and then sftp the 
+ 
+ results to people.apache.org. To deploy the build artifacts to your local file system, set
up project.properties 
+ 
+ something like this:
  
    {{{maven.repo.list=apache
  maven.repo.apache=file://~/zdir
@@ -328, +687 @@

     $ maven multiproject:deploy
  
  
-   This will build the artifacts into a subtree rooted at garbage. Use sftp to bulk put the
artifacts into the corresponding subdirectories of www/people.apache.org/repo/m1-ibiblio-rsync-repository/org.apache.derby/.
+   This will build the artifacts into a subtree rooted at garbage. Use sftp to bulk put the
artifacts into the 
+ 
+ corresponding subdirectories of www/people.apache.org/repo/m1-ibiblio-rsync-repository/org.apache.derby/.
  
  
   1. Update the Derby project DOAP file for an official release.
@@ -336, +697 @@

      Update the release section in this file:
      https://svn.apache.org/repos/asf/db/derby/site/trunk/doap_Derby.rdf
  
-    This DOAP file is the source for http://projects.apache.org/projects/derby.html . Projects
are supposed to get updated periodically (you don't do anything to publish the update). If
the update doesn't get generated within a day or two, send email to derby-dev@db.apache.org
letting them know you updated the file and that the update appears to be delayed (site-dev@apache.org
needs to be notified).
+    This DOAP file is the source for http://projects.apache.org/projects/derby.html . Projects
are supposed to get 
+ 
+ updated periodically (you don't do anything to publish the update). If the update doesn't
get generated within a day 
+ 
+ or two, send email to derby-dev@db.apache.org letting them know you updated the file and
that the update appears to 
+ 
+ be delayed (site-dev@apache.org needs to be notified).
  
  
   1. Announce the release.
  
-   Twenty-four hours after putting the release files in the mirror directory, verify that
you can reach them through a mirror. Then, you should email derby-dev, derby-user, general@db.apache.org,
announce@apache.org and anyone else you think might be interested an announcement concerning
the release. See past release announcements for examples.
+   Twenty-four hours after putting the release files in the mirror directory, verify that
you can reach them through 
  
-   Include a description of the project, and a description of any significant new features
or important bug fixes. Every tech news blog remotely related to Java or databases will pick
up the announcement and post it verbatim, so it's a good idea to spell check it, proofread
it a couple of times, and/or get input from derby-dev on its content.
+ a mirror. Then, you should email derby-dev, derby-user, general@db.apache.org, announce@apache.org
and anyone else 
+ 
+ you think might be interested an announcement concerning the release. See past release announcements
for examples.
+ 
+   Include a description of the project, and a description of any significant new features
or important bug fixes. 
+ 
+ Every tech news blog remotely related to Java or databases will pick up the announcement
and post it verbatim, so 
+ 
+ it's a good idea to spell check it, proofread it a couple of times, and/or get input from
derby-dev on its content.
  
   1. Tag the release in subversion.
  
-   {{{svn copy -r {rev} https://svn.apache.org/repos/asf/db/derby/code/{trunk_or_branchname}/
https://svn.apache.org/repos/asf/db/derby/code/tags/{version}/
+   {{{svn copy -r {rev} https://svn.apache.org/repos/asf/db/derby/code/{trunk_or_branchname}/

- svn copy -r {rev} https://svn.apache.org/repos/asf/db/derby/docs/{trunk_or_branchname}/
https://svn.apache.org/repos/asf/db/derby/docs/tags/{version}/}}}
+ 
+ https://svn.apache.org/repos/asf/db/derby/code/tags/{version}/
+ svn copy -r {rev} https://svn.apache.org/repos/asf/db/derby/docs/{trunk_or_branchname}/

+ 
+ https://svn.apache.org/repos/asf/db/derby/docs/tags/{version}/}}}
  
   1. Update STATUS again.
  
@@ -357, +736 @@

  == Snapshots ==
   1. Update CHANGES.
  
-  Edit the CHANGES file to include a list of the bug fixes included in the snapshot. It is
not necessary to make an exhaustive list of subversion commits. Only changes that would be
visible to a user need to be included.
+  Edit the CHANGES file to include a list of the bug fixes included in the snapshot. It is
not necessary to make an 
+ 
+ exhaustive list of subversion commits. Only changes that would be visible to a user need
to be included.
  
   1.#2 Run the snapshot target.
  
@@ -371, +752 @@

  ant insane
  ant -Dsane=false snapshot}}}
  
-  It is best to do this in a view where there are no modified files or mixed revisions. This
will create a snapshot directory at the top level, which will contain the five snapshot files:
+  It is best to do this in a view where there are no modified files or mixed revisions. This
will create a snapshot 
+ 
+ directory at the top level, which will contain the five snapshot files:
  
    * db-derby-snapshot-[version]-[changenumber].tar.gz
    * db-derby-snapshot-[version]-[changenumber].zip
@@ -387, +770 @@

  
   http://db.apache.org/derby/papers/derby_web.html
  
-   a. Place the five files created by the snapshot target into the src/documentation/content/xdocs/binaries
directory of the location to which you checked out the website source. 'svn add' them, and
'svn delete' any old snapshot that the new snapshot is replacing. Don't forget to 'svn add'
the files in the build part of the site tree.
+   a. Place the five files created by the snapshot target into the src/documentation/content/xdocs/binaries
directory 
  
+ of the location to which you checked out the website source. 'svn add' them, and 'svn delete'
any old snapshot that 
+ 
+ the new snapshot is replacing. Don't forget to 'svn add' the files in the build part of
the site tree.
+ 
-  b. Update the derby_downloads.xml page in the src/documentation/content/xdocs directory
so that the links to the current snapshot point to your new files.
+  b. Update the derby_downloads.xml page in the src/documentation/content/xdocs directory
so that the links to the 
+ 
+ current snapshot point to your new files.
  
   c. Run 'forrest site' at the top of the site tree.
  
-  d. Check the changes. If they look good, 'svn commit' them. NOTE: you should revert any
changed files in build/tmp or build/site/skin. Also, please {{{svn delete}}} any old snapshot
files that are no longer necessary.
+  d. Check the changes. If they look good, 'svn commit' them. NOTE: you should revert any
changed files in build/tmp 
+ 
+ or build/site/skin. Also, please {{{svn delete}}} any old snapshot files that are no longer
necessary.
  
   e. Update the website on people.apache.org by logging into the machine and doing:
  
   {{{cd /www/db.apache.org/derby
  svn up}}}
  
-  Note that people.apache.org is rsync'd to the actual website every hour or so. Verify that
the changes appear on the Derby website at http://db.apache.org/derby/derby_downloads.html
+  Note that people.apache.org is rsync'd to the actual website every hour or so. Verify that
the changes appear on 
+ 
+ the Derby website at http://db.apache.org/derby/derby_downloads.html
  
   1.#4 Bump the version number.
  
@@ -409, +802 @@

   {{{cd tools/release
  ant bumplastdigit}}}
  
-  This target updates tools/ant/properties/release.properties and several test canons that
contain the version number. Check that the version number is correct. 'svn commit' the changed
files.
+  This target updates tools/ant/properties/release.properties and several test canons that
contain the version 
+ 
+ number. Check that the version number is correct. 'svn commit' the changed files.
  
   1.#5 Announce to the lists.
  
-  It's a good idea, once the snapshot has appeared on the site, to announce to derby-dev
and derby-user that the new snapshot has been posted so interested testers can grab it.
+  It's a good idea, once the snapshot has appeared on the site, to announce to derby-dev
and derby-user that the new 
  
-  Also, a new JIRA version will need to be created for the new, bumped version number. An
email to derby-dev stating that you've bumped the version will (hopefully) be sufficient to
get the attention of one of the Derby JIRA admins to add a new version in JIRA.
+ snapshot has been posted so interested testers can grab it.
  
+  Also, a new JIRA version will need to be created for the new, bumped version number. An
email to derby-dev stating 
+ 
+ that you've bumped the version will (hopefully) be sufficient to get the attention of one
of the Derby JIRA admins 
+ 
+ to add a new version in JIRA.
+ 
+ 

Mime
View raw message