Author: tfischer
Date: Fri Sep 21 20:48:04 2012
New Revision: 1388675
URL: http://svn.apache.org/viewvc?rev=1388675&view=rev
Log:
documented current release procedure
Modified:
db/torque/torque4/trunk/torque-site/src/site/xdoc/developer-info/developer-guide.xml
db/torque/torque4/trunk/torque-site/src/site/xdoc/developer-info/site-edit-deploy.xml
Modified:
db/torque/torque4/trunk/torque-site/src/site/xdoc/developer-info/developer-guide.xml
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/developer-info/developer-guide.xml?rev=1388675&r1=1388674&r2=1388675&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-site/src/site/xdoc/developer-info/developer-guide.xml
(original)
+++
db/torque/torque4/trunk/torque-site/src/site/xdoc/developer-info/developer-guide.xml
Fri Sep 21 20:48:04 2012
@@ -44,10 +44,10 @@
<subsection name="Command line build">
<p>
- Change into the directory torque-maven-parent in your local copy
- of the torque 4 trunk. Run <code>mvn install</code>.
- The runtime, generator, templates and maven 2 generator plugin
- will be built in turn and installed
+ Change into the directory into which you checked out the
+ torque 4 trunk. Run <code>mvn install</code>.
+ The runtime, generator, templates, maven 2 generator plugin
+ and ant tasks will be built in turn and installed
in your local maven 2 repository.
</p>
</subsection>
@@ -132,10 +132,8 @@
<section name="Building a release / release candidate">
<p>
- Run <code>mvn -Prelease clean install</code> to build a release
- and install the artifacts in your local maven repository.
- This will also run gpg to sign all created artifacts. For this to work,
- you need <a href="www.gnupg.org/">gpg</a> installed.
+ You need <a href="www.gnupg.org/">gpg</a> installed for building
+ a release.
Possibly, you need to change some gpg defaults. This can be done in
the profiles section of the maven configuration file settings.xml.
E. g.
@@ -158,11 +156,72 @@
<activeProfile>gnupg</activeProfile>
</activeProfiles>
]]></source>
- </section>
-
- <section name="Deploying a release">
<p>
- TODO
+ You also need to define the servers to deploy to in your settings.xml
+ E.g.
+ </p>
+<source><![CDATA[
+ <servers>
+ <server>
+ <id>apache.website</id>
+ <username>tfischer</username>
+ <filePermissions>664</filePermissions>
+ <directoryPermissions>775</directoryPermissions>
+ </server>
+ <server>
+ <id>apache.releases.https</id>
+ <username>tfischer</username>
+ <password>${encrypted apache password}</password>
+ </server>
+ </servers>]]></source>
+ <p>
+ Before building a release, check that the project builds with tests
+ and check the test project against the various databases.
+ </p>
+ <p>
+ To start building a release, run
+ <code>mvn -Ptest,derbyEmbedded release:prepare</code>.
+ This will change the version in the poms to the release version
+ and then run a clean verify cycle on the new poms. This will fail
+ because the test project needs the maven plugin which is not installed
+ in the new version yet. To fix this, run
+ <code>rm test-project/derby.log</code> and
+ <code>mvn install</code> to install the torque maven plugin
+ in the release version.
+ Then run again
+ <code>mvn -Ptest,derbyEmbedded release:prepare
+ -Dusername=YourApacheUsername -Dpassword=YourApachePassword</code>
+ to finish building the release, creating a tag for the release and
+ changing the pom's version entry to the new development version.
+ </p>
+ <p>
+ To build the release and install it in the nexus taging repository,
+ run <code>mvn -Ptest,derbyEmbedded release:perform</code>.
+ </p>
+ <p>
+ To test the release, login into https://repository.apache.org and
+ download the source distribution from the staging repository.
+ Remove the already installed release artifacts
+ from your local maven repository, and check the source release builds.
+ Then change into the test project of the source release,
+ adjust the database properties in the profiles and run the test project
+ against the various databases.
+ </p>
+ <p>
+ Adjust the version numbers in the site.
+ </p>
+ <p>
+ Call a vote on the torque dev list and forward to the db private list.
+ When the vote is finished, post the result to the dev list and again
+ forward to the db private list.
+ </p>
+ <p>
+ When the vote is accepted, promote the staging repository in nexus and
+ copy the distribution files to the directory
+ /www/www.apache.org/dist/db/torque on people.apache.org.
+ Deploy the site.
+ When the various rsyncs are through, announce the release on the
+ torque user list.
</p>
</section>
Modified:
db/torque/torque4/trunk/torque-site/src/site/xdoc/developer-info/site-edit-deploy.xml
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-site/src/site/xdoc/developer-info/site-edit-deploy.xml?rev=1388675&r1=1388674&r2=1388675&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-site/src/site/xdoc/developer-info/site-edit-deploy.xml
(original)
+++
db/torque/torque4/trunk/torque-site/src/site/xdoc/developer-info/site-edit-deploy.xml
Fri Sep 21 20:48:04 2012
@@ -41,11 +41,11 @@
The subprojects do not have an own xdoc subdirectory.
</p>
<p>
- For a local build of the site, cd into torque-maven-parent and run
+ For a local build of the site, cd into the torque parent dir and run
<code>mvn post-site</code> (if you just run <code>mvn site</code>,
the reports from the other modules will not be pulled in).
When finished, the site can be found in
- ../torque-site/target/site.
+ torque-site/target/site.
</p>
<subsection name="Transferring the module reports to the main site">
<p>
@@ -153,7 +153,8 @@
<section name="Updating the site for a new release">
<p>
- TODO
+ Check that all version numbers are up to date, especially in the
+ tutorial, usage pages and on the download page.
</p>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
