Home > Guides > Contributors Guide > Creating and Signing a Distribution > Building Struts 2 - Normal release

Content

Building Steps (Struts)

Getting ready

  1. Create an "Struts 2.x.y omnibus ticket" ticket in JIRA to refer to in upcoming release related commit comments and for general documentation purposes. Mark it with priority "Blocker".
  2. Ensure that the master POM and Struts Annotations have current releases
  3. Review JIRA for any issues without a fix version set, and for any issues that should be resolved for the pending release.
  4. Ensure that there are no repositories or pluginRepositories listed in the poms.
  5. If you have committed all changes regarding the release process, close the omnibus ticket as it is the last open ticket for the upcoming release
  6. Release the upcoming version in JIRA (under Administration/Manage Releases) and tag the release date
  7. Add next milestone version to the JIRA roadmap
  8. Create DONE and TODO filters for the new version, share with all, and remove obsolete TODO filter
  9. Create a new Version Notes page in Confluence, link from Migration Guide, and link to prior release page and JIRA DONE filters of the version to release
Icon

Before starting release process make sure that the Docs were exported to https://cwiki.apache.org/WW/! Check the Version Notes page!

Obtain a fresh checkout.

Change site target

Edit the top pom.xml file and replace 2.x the url below with major.minor.x part of version number that's going to be released (eg. version is 2.3.10 -> 2.3.x) and rename development folder to release.

Before:
After:

commit the change

Update version of archetypes

Edit src/site/resources/archetype-catalog.xml and change version of archetypes to current $VERSION, save and commit.

Prepare release

Tag the release by using the "release:prepare" goal of Maven:

For a dry run, add -DdryRun=true. If you do a dry run, use mvn release:clean to clean up after you have looked at the output.

When prompted for the SCM tag name, follow this pattern: STRUTS_2_3_[PATCH_VERSION]

Icon

For some reason, when using svn client 1.5, the release plugin might fail to tag the release, if it fails, run:
svn up -r head
mvn release:prepare -Dresume

Icon

If you get the error message above, try to re-run mvn release:prepare -Dusername=yourSvnUsername -Dpassword=yourSvnPassword -DautoVersionSubmodules=true command again, -Dresume flag is set to true by default and the plugin will resume the release process from where it failed before.

This step will (more information):

  • Check that there are no uncommitted changes in the sources
  • Check that there are no SNAPSHOT dependencies
  • Change the version in the poms from x-SNAPSHOT to a new version (you will be prompted for the versions to use)
  • Transform the SCM information in the POM to include the final destination of the tag
  • Run the project tests against the modified POMs to confirm everything is in working order
  • Commit the modified POMs
  • Tag the code in the SCM with a version name (this will be prompted for)
  • Bump the version in the POMs to a new value y-SNAPSHOT (these values will also be prompted for)
  • Commit the modified POMs

Perform the release

This step will (more information):

  • Checkout from an SCM URL with optional tag
  • Run the predefined Maven goals to release the project (by default, deploy site-deploy)

After this step the artifacts will be hosted by Nexus

If you need to run perform again, (or in a different box), do:

Next, log in to Nexus and close staging repository.

Icon

Repository is identified by user name and public IP address, so if in meantime your IP changed, a new staging repository will be created so you must drop the old one (check the dates!) - if IP is the same, artifacts will be uploaded to the same repository as first attempt.

Move the assemblies

To simplify testing, the assemblies have to be moved to the /www/people.apache.org/builds/struts/$VERSION dir.

After closing repository in Nexus, check if the release files are available from staging repository as bellow:

In order to move the assemblies login to people.apache.org and execute the following code:

After that move the assemblies directory to the builds destination with

Jira stuff

  • Update JIRA roadmap with tag/release date - release the version in JIRA
  • Add next milestone to the JIRA roadmap
  • Create DONE and TODO filters, share with all, and remove obsolete TODO filter
  • Create new release page, link from Migration Guide, and link to prior release page and JIRA filters

Announce availability

Send a short e-mail to dev@struts.a.o informing about the new packages and to give people enough time to test the distribution (actual bits). Wait around a week before posting Vote. If no show-stoppers reported, start a vote thread for build quality designation.

Vote on it

Post a release/quality vote to the dev list (and only the dev list). The example mail is on Sample Announcements page.
If the vote result is for an ASF release (i.e. not test build), update site, announce. If the vote result is for GA, push to central.

Copy files

After the vote, if the distribution is being mirrored (there was a favourable release vote) copy the Sources and Binaries:

If a new DTD was defined, add it to https://svn.apache.org/repos/asf/struts/site/trunk/pom.xml, in get-dtds execution section.

Icon

The default setup on people.apache.org will leave the files and directories only changeable by the user who creates them. The last two steps will allow future releases to go smoothly.

Promote release

Log in again to Nexus and release the repository, it will be automatically replicated across Maven Repositories
See Releasing a Maven-based project for further details.

Clean up old releases

Remove the old files from under /www/www.apache.org/dist/struts/ to synchronise only the latest version with peers. All the files from /www/www.apache.org/dist/ are always mirrored to http://archive.apache.org/dist/struts/. You can use the below command:

cd /www/www.apache.org/dist/struts/
find . -type f -name "struts-2.3.x*" -exec rm -f {} \;

where x is the previous version to remove (or one more previous to keep current and one version back).

Wait for rsync

Wait 24 hours before proceeding.

(Optional) - Update Security Bulletins

If the release will fix a - hopefully yet undisclosed - security issue, it's now time to update the Security Bulletins page and add a new announcement. For a template, just check former announcements

Icon

The below is not true any more - please wait for update!

Update site (Struts 2 site)

Edit /www/struts.apache.org/$VERSION/archetype-catalog.xml and update the version of artifacts

Update site (Struts top level site)

  • Check out site src code
  • Update xml files
    • struts-site/src/site/xdoc/announce.xml (if applicable, refer also to corresponding security bulletin)
    • struts-site/src/site/xdoc/downloads.xml (remove previous version)
    • struts-site/src/site/xdoc/download.xml (remove previous version)
    • struts-site/src/site/xdoc/index.xml
    • struts-site/src/site/site.xml
    • struts-site/src/site/resources/archetype-catalog.xml
  • Commit the changes
  • Generate the site
  • Open struts-site/target/site/index.html and verify the urls and versions are right
  • Deploy site
    It takes a few hours for the site changes to go live

Rollback site target

Revert back the site target to 2.x and commit the change

Redeploy the draft docs (Optional)

Make public available all the pages that could leak confidential information about the vulnerability. Wait or manually export the space in Confluence. Build snapshot locally and copy assembly/target/assembly/out/struts2-#.#.#-SNAPSHOT-docs.zip to people.apache.org and update /www/struts.apache.org/2.x/docs

Permissions

After updating the site, be sure that the permissions are set to group writeable ($ chmod -R g+w .)

Post announcements

We leave this as the last step, once the artifacts have had time to sync up on the mirrors. Target it to: user@struts.a.o and announcements@struts.a.o, samples are available at Sample announcements page