Building Steps (Struts)
- 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".
- Switch to branch
- Ensure that the master POM and Struts Annotations have current releases
- Review JIRA for any issues without a fix version set, and for any issues that should be resolved for the pending release.
- Ensure that there are no repositories or pluginRepositories listed in the poms.
- 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
- Release the upcoming version in JIRA (under Administration/Manage Releases) and tag the release date
- Add next milestone version to the JIRA roadmap
- Create DONE and TODO filters for the new version, share with all, and remove obsolete TODO filter
- 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
- Export wiki pages and put them under
Update Draft Docs when needed
struts-site project (see details at the bottom of this page) and perform export:
If build will fail try again - don't use
clean, the exporter is going to update only outdated pages. After successful export, commit updated files into
Be sure your local copy is up-to-date
Please remember to keep BOM subproject in sync -
<struts-version.version>X.X.X</struts-version.version> - must be the same as the parent pom. The latest Maven version handles this case very well but it's worth checking if the bits are in sync.
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]
If you get an error message, try to re-run
mvn release:prepare -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.
Follow the link to get more information about performed operation by release plugin.
Perform the release
Follow the link to get more information about performed operation by release plugin. After this step the artifacts will be hosted by Nexus. The
-DretryFailedDeploymentCount=10 is needed when there are problems with network connection (used just in case).
If you need to run perform again, (or in a different box), do:
Next, log in to Nexus and close staging repository.
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
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 this step artifacts are available for test here https://dist.apache.org/repos/dist/dev/struts/
Send a short e-mail to email@example.com 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.
Do not forget to push your local changes to the Apache repo
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.
After the vote, if the distribution is being mirrored (there was a favourable release vote) move all the artefacts from
dev folder into
Clean up old releases
Remove the old files from under https://dist.apache.org/repos/dist/release/struts/ to synchronise only the latest version with peers. All the files from https://dist.apache.org/repos/dist/release/struts/ are always mirrored to http://archive.apache.org/dist/struts/. You can use the below command:
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.
Make sure you have linked your Apache and Github account in Apache GitBox (Dual Master Git alowing you to directly push to GitHub), see https://gitbox.apache.org/setup/
Check out site src code
or use SSH instead:
- If a new DTD was defined, add it to
- Update current version and release date in
- Update page source files
- struts-site/source/announce.md (if applicable, refer also to corresponding security bulletin)
- struts-site/source/downloads.html (Prior Releases section)
- struts-site/source/index.html (some parts will updated automatically with values defined in
- Generate site with Docker Jekyll image
- you must have Docker installed and running
- if you are doing this the first time, download the official Struts image to build the site from https://hub.docker.com/r/theapachestruts/struts-site-jekyll/
- now you can use one of the bash scripts already provided in the
docker-run.sh- used with Bash
docker-run.fish- to use with Fish Shell (via
- now you can check the generated site at http://localhost:4000
Commit the changes and the generated content
Now the changes must be deployed to production which is basically a separated Subversion repository, you check it out with command below:
It's a good idea to keep that working copy to be used with future releases. Right now copy content of
struts-site/content folder to
struts-production folder, then commit changes. Next step is to update exported wiki pages. With current approach the pages are kept in
Redeploy the docs (Optional)
Checkout source of the website and export Confluence pages
Now the whole Confluence space is exported to
Checkout copy of production website (if you didn't that before)
(you can checkout just a subtree, but it's better to checkout the whole repo especially when you want to update also the main web page)
We leave this as the last step, once the artifacts have had time to sync up on the mirrors. Target it to: firstname.lastname@example.org, email@example.com and firstname.lastname@example.org, samples are available at Sample announcements page