[CONF] Apache Tapestry > Release Process

[confluence]

Release Process Page edited by Igor Drobiazko Changes (11) h2. Prerequisites Before creating a release ensure: * you have setup your own public OpenGPG key signature for signing the distribution * you can login to [Nexus|https://repository.apache.org/index.html#stagingRepositories] * your local _settings.xml_ contains valid SVN and deployment credentials h2. SVN and Deployment Credentials To successfully create a release, you will need to update your Maven Settings with the credentials for your SVN user and the deployment user. These credentials are stored in the Maven Settings file in _\~/.m2/settings.xml_. {code}<settings> ... <servers> <server> <id>svn.apache.org</id> <username>youruser</username> <password>secretpassword</password> </server> <server> <id>apache.releases.https</id> <username>youruser</username> <password>secretpassword</password> </server> </servers> ... </settings>{code} h2. Release Steps {float:right|background="" {contentbylabel:title=Related Articles|showLabels=false|showSpace=false|labels=tapestry-dev} {float} The process can be summarized as: * Update your _Subversion_ workspace to {{[https://svn.apache.org/repos/asf/tapestry/tapestry5/trunk]}} * Manually update the tapestry version in the source code of the Tapestry archetype (found in quickstart/src/main/resources/archetype-resources/pom.xml) to the version number about to be released (i.e., strip off "-SNAPSHOT") * Commit that change to SVN * {{mvn release:prepare \-DautoVersionSubmodules=true}} * {{mvn release:perform}} * Generate and upload Binary / Source distributions ** {{svn sw https://svn.apache.org/repos/asf/tapestry/tapestry5/tags/releases/}}_version_ ** {{svn sw}} {{[https://svn.apache.org/repos/asf/tapestry/tapestry5/tags/releases/]}}{_}version_ ** The {{ant}} build script creates the distributions ** There's some manual work to sign and upload the distributions ... ** Update with text about any unusual aspects of the upgrade (especially, non-backwards compatible changes) ** Paste the HTML release notes content into the new page (you'll have to use the \{html\} macro) ** Update [Release Notes] index page to point to the new page * Send vote email ... *3 days pass* * Login to [Nexus|https://repository.apache.org/index.html#stagingRepositories] and *release* the version's repository ... * Create a Confluence blog entry to describe the new release (this will automatically appear on the Tapestry home page) * Generate and deploy site documentation: ** {{mvn clean site site:deploy \-Pjavadoc}} ** Budget about _30 minutes_ for this to run\! {warning} Be aware that Maven will perform some automatic Subversion commits, and even create the new release tag for you\! Make sure to get those version numbers right; I've found to my dismay that it can be tricky to correct this after-the-fact. {warning} ... > rm -rf /www/www.apache.org/dist/tapestry/tapestry-*5.2.1* > mv * /www/www.apache.org/dist/tapestry/ > {code} ... h2. Notes {{mvn release:prepare}} does a very good job at guessing the right version numbers (i.e., stripping off the \-SNAPSHOT suffix for the release version, and incrementing the version number for the new development version). If it's one of your first releases, consider trying {{mvn release:prepare \-DdryRun=true}} and manually observing the differences in the poms (this command will not commit the updated poms - it'll just generate them). See [the Maven documentation|http://maven.apache.org/plugins/maven-release-plugin/introduction.html] for more details. The Maven code assumes it is executing inside a Subversion (not Git+SVN) workspace. I often create a fresh checkout into a new directory. ... {noformat} I've created and uploaded a release of Tapestry 5.x.x, ready to be voted upon. The binary and source downloads are uploaded to: ... Full Content Prerequisites Before creating a release ensure: you have setup your own public OpenGPG key signature for signing the distribution you can login to Nexus your local settings.xml contains valid SVN and deployment credentials SVN and Deployment Credentials To successfully create a release, you will need to update your Maven Settings with the credentials for your SVN user and the deployment user. These credentials are stored in the Maven Settings file in ~/.m2/settings.xml. <settings> ... <servers> <server> <id>svn.apache.org</id> <username>youruser</username> <password>secretpassword</password> </server> <server> <id>apache.releases.https</id> <username>youruser</username> <password>secretpassword</password> </server> </servers> ... </settings> Release Steps Related Articles Page: Confluence Site Setup Page: Release Process Page: Developer Bible Page: Developer Information The process can be summarized as: Update your Subversion workspace to https://svn.apache.org/repos/asf/tapestry/tapestry5/trunk Manually update the tapestry version in the source code of the Tapestry archetype (found in quickstart/src/main/resources/archetype-resources/pom.xml) to the version number about to be released (i.e., strip off "-SNAPSHOT") Commit that change to SVN mvn release:prepare -DautoVersionSubmodules=true mvn release:perform Generate and upload Binary / Source distributions svn sw https://svn.apache.org/repos/asf/tapestry/tapestry5/tags/releases/version The ant build script creates the distributions There's some manual work to sign and upload the distributions Login to Nexus and close the automatically created staging repository, and note its url Use the Manage Versions page in JIRA to add a new version Release the version, moving outstanding issues to the new version Generate HTML Release Notes for the version Create a new child page of Release Notes (it may already exist) Update with text about any unusual aspects of the upgrade (especially, non-backwards compatible changes) Paste the HTML release notes content into the new page (you'll have to use the {html} macro) Update Release Notes index page to point to the new page Send vote email ... 3 days pass Login to Nexus and release the version's repository Enter "Tapestry 5.x.x beta release" (adjust as necessary) for the message The version will disappear from the list of repositories after releasing it SSH to people.apache.org and copy the Binary / Source distributions to the right directory Once files reach all mirrors, update the Downloads Page Create a Confluence blog entry to describe the new release (this will automatically appear on the Tapestry home page) Generate and deploy site documentation: mvn clean site site:deploy -Pjavadoc Budget about 30 minutes for this to run! Be aware that Maven will perform some automatic Subversion commits, and even create the new release tag for you! Make sure to get those version numbers right; I've found to my dismay that it can be tricky to correct this after-the-fact. There's a couple of steps to moving the distributions; you have to delete the prior release (unless its a stable release) and get some permissions set up correctly: > cd public_html/tapestry-releases/ > ls -l total 43631 -rw-r--r-- 1 hlship tapestry 8722101 Oct 24 15:58 tapestry-bin-5.2.2.tar.bz2 -rw-r--r-- 1 hlship tapestry 195 Oct 24 15:58 tapestry-bin-5.2.2.tar.bz2.asc -rw-r--r-- 1 hlship tapestry 33 Oct 24 15:58 tapestry-bin-5.2.2.tar.bz2.md5 -rw-r--r-- 1 hlship tapestry 8750103 Oct 24 15:58 tapestry-bin-5.2.2.tar.gz -rw-r--r-- 1 hlship tapestry 195 Oct 24 15:58 tapestry-bin-5.2.2.tar.gz.asc -rw-r--r-- 1 hlship tapestry 33 Oct 24 15:58 tapestry-bin-5.2.2.tar.gz.md5 -rw-r--r-- 1 hlship tapestry 8823868 Oct 24 15:58 tapestry-bin-5.2.2.zip -rw-r--r-- 1 hlship tapestry 195 Oct 24 15:58 tapestry-bin-5.2.2.zip.asc -rw-r--r-- 1 hlship tapestry 33 Oct 24 15:58 tapestry-bin-5.2.2.zip.md5 -rw-r--r-- 1 hlship tapestry 4920211 Oct 24 15:59 tapestry-src-5.2.2.tar.bz2 -rw-r--r-- 1 hlship tapestry 195 Oct 24 15:59 tapestry-src-5.2.2.tar.bz2.asc -rw-r--r-- 1 hlship tapestry 33 Oct 24 15:59 tapestry-src-5.2.2.tar.bz2.md5 -rw-r--r-- 1 hlship tapestry 5409252 Oct 24 15:59 tapestry-src-5.2.2.tar.gz -rw-r--r-- 1 hlship tapestry 195 Oct 24 15:59 tapestry-src-5.2.2.tar.gz.asc -rw-r--r-- 1 hlship tapestry 33 Oct 24 15:59 tapestry-src-5.2.2.tar.gz.md5 -rw-r--r-- 1 hlship tapestry 7618776 Oct 24 16:00 tapestry-src-5.2.2.zip -rw-r--r-- 1 hlship tapestry 195 Oct 24 16:00 tapestry-src-5.2.2.zip.asc -rw-r--r-- 1 hlship tapestry 33 Oct 24 16:00 tapestry-src-5.2.2.zip.md5 > chmod 664 * > rm -rf /www/www.apache.org/dist/tapestry/tapestry-*5.2.1* > mv * /www/www.apache.org/dist/tapestry/ > Notes mvn release:prepare does a very good job at guessing the right version numbers (i.e., stripping off the -SNAPSHOT suffix for the release version, and incrementing the version number for the new development version). If it's one of your first releases, consider trying mvn release:prepare -DdryRun=true and manually observing the differences in the poms (this command will not commit the updated poms - it'll just generate them). See the Maven documentation for more details. The Maven code assumes it is executing inside a Subversion (not Git+SVN) workspace. I often create a fresh checkout into a new directory. The correct response to this prompt: What is the SCM release tag or label for "Tapestry 5 Project" is 5.X.X This reflects that Tapestry stores its SVN tags in a slightly weird way (that made perfect sense at the time). A template for the vote e-mail: I've created and uploaded a release of Tapestry 5.x.x, ready to be voted upon. The binary and source downloads are uploaded to: http://people.apache.org/~XXX/tapestry-releases/ and the Maven artifacts staged to: https://repository.apache.org/content/repositories/orgapachetapestry-XXX/ Please examine these files to determine if the new release, 5.X.X, is ready. I've also created a 5.X.X tag in Subversion: http://svn.apache.org/viewvc/tapestry/tapestry5/tags/releases/5.X.X/ On a successful vote, I'll move the files from these directories to the proper distribution directories and update the Tapestry site documentation. Vote will run for three days; on success I'll move the voted artifacts into place and send out appropriate notifications. I often embellish this template with extra detail. Change Notification Preferences View Online | View Changes