How to prepare a normal release ?
- create a Version Notes page and start adding important changes to it
- create a filter in JIRA with Fix Version pointing to the release version you want to prepare
- review JIRA issues and re-organise them, move the Fix Version to the next release or Future, mark what should be solved in the release you're working on
- update the Draft Docs page - build project locally, upload struts2-assembly-docs.zip to people.a.o and move the content to /www/struts.apache.org/2.x/docs/
- or you can use the script below to update the Draft Docs after login to people.a.o:
No Format #!/bin/sh wget -erobots=off -nH -nv -E -L --directory-prefix=cwiki --no-check-certificate -r https://cwiki.apache.org/WW/ rm -r /www/struts.apache.org/2.x/docs/* mv cwiki/WW/* /www/struts.apache.org/2.x/docs/ chmod -R g+w /www/struts.apache.org/2.x/docs/ chown -R :struts /www/struts.apache.org/2.x/docs/ rm -r cwiki
How to prepare a fast track release ?
- keep all the informations confidential as possible, communicate throughout security@struts.a.o group
- restrict access to all the related pages created in Confluence to struts-committers group only, they can be made public available after fix or workaround was released
What do you want to build ?
Depends on what you want to achieve, please select topic from the list below:
- One time steps - before you start preparing a distribution
- Sample announcements - announcements used to communicate the achievement
- Building Struts Master - how to release Struts Master
- Building Struts Annotations - when you want to prepare a new distribution of Struts Annotations (if something changed)
- Building Struts 2 - Normal release - the most common used path
- Building Struts 2 - Fast track release - how to prepare a fast track release with important security patch
Tip |
---|
Developers using Linux workstations can skip over the references to PuTTY and Cygwin |
Each time
(There are also one-time setup instructions)
0 | Ensure that the master POM and Struts Annotations have current releases. | ||
---|---|---|---|
1 | Delete the struts2 items in your local Maven2 repository and obtain a fresh checkout.
| ||
2 | Update the POMs to remove "-SNAPSHOT" from the version, commit the POM changes, and note the revision number | ||
3 | Tag the release by making a SVN copy of the head or designated revision | ||
|
| ||
4 | Assemble the release (see notes) | ||
|
| ||
5 | Under CygWin or Linux, sign the Maven artifacts (in | ||
|
| ||
6 | Deploy the Maven artifacts to the staging repository | ||
| Make sure the staging repository at {{ http://people.apache.org/builds/struts/m2-staging-repository![]() }} is empty or missing, then:
| ||
7 | Sign the Maven artifacts (in | ||
|
| ||
| (Under CygWin, use the | ||
8 | | ||
9 | Update your usual working copy, change the POMs to next version number, add the "-SNAPSHOT" suffix, and commit the POM changes. | ||
10 | Update JIRA roadmap with tag/release date; Add next milestone to the JIRA roadmap; Create DONE and TODO filters, share with all, and remove obsolete TODO filter; Create new release page and link to prior release page and JIRA filters. Update site.xml with link to new release notes. | ||
11 | Deploy the new snapshot | ||
|
| ||
12 | Announce the test build to the dev list first. Wait 3-7 days and, if appropriate, post a release/quality vote. If the distribution is being mirrored (there was a favorable release vote), copy the ZIPs to |
One time
Create and install a SSH key
1 | Install PuTTY |
---|---|
2 | Use PuttyGen to create a SSH key (see Putty help for details) |
3 | Use PuTTY to ssh to people.apache.org |
4 | Create a ~/.ssh folder |
5 | |
6 | ssh to p.a.o |
7 | Create a |
8 | Configure putty to use your private key and save the session |
Create a PGP key
1 | Install cgywin, including utils/gpg |
---|---|
2 | Generate a key with |
3 | Backup your cygwin home directory to another media |
4 | Add your key to |
Update Maven settings for our servers
1 | Create a settings.xml under .m2 (in your Document and Settings folder) | ||
---|---|---|---|
|
|
Expose a copy of known hosts to Maven
1 | From cygwin, ssh to people.apache.org, save the public key if prompted, and exit |
---|---|
| cygwin will save the known hosts to your |
2 | From cygwin (not Windows) create another |
3 | Copy the |
Resources
- Apache Struts Release Guidelines
- Struts Maintenance Guide for Maven
- Signing Releases
- Wendy's notes on Release Signing
- Apache Mirroring Guidelines
Retagging
If a tagged build needs to be retagged, be sure to delete the old tag first.
Code Block |
---|
svn delete https://svn.apache.org/repos/asf/struts/struts2/tags/STRUTS_#_#_# -m "WW-### Removing first try at 2.#.#." |
Interim Notes on Cobbling a Distribution
To update the Java 4 distribution
Before tagging
- If needed, update the translator JARs and translate batch file under "backport"
- If needed, update the translate batch file as to the Struts version under "backport"
After assembly, before signing
- Extract assembly to a root drive (
\struts-2.0.x
) - Copy (export) the "backport" folder that is under SVN to
\struts-2.0.x\j4
- Run the translate batch file
- Create struts-2.0.x-j4.zip archive
- Also create a struts-2.0.x-docs.zip archive
- Update struts-2.0.x-all.zip archive
Sample Test Build Announcement
Test builds are only announced to the dev list. Announcements to the user list can only be made pursuant to a release vote with the consent of the PMC.
The test build of Struts 2.0.3 is available.
No determination as to the quality ('alpha,' 'beta,' or 'GA') of Struts 2.0.3 has been made, and at this time it is simply a "test build". We welcome any comments you may have, and will take all feedback into account if a quality vote is called for this build.
Release notes:
Wiki Markup \[LINK\]
Distribution:
Maven 2 staging repository:
We appreciate the time and effort everyone has put toward contributing code and documentation, posting to the mailing lists, and logging issues.
Sample Release/Quality Vote
The Struts #.#.# test build has been available since ## ### ####.
Release notes:
Wiki Markup \[LINK\]
Distribution:
Maven 2 staging repository:
If you have had a chance to review the test build, please respond with a vote on its quality:
Wiki Markup \[ \] Leave at test build \[ \] Alpha \[ \] Beta \[ \] General Availability (GA)
Everyone who has tested the build is invited to vote. Votes by PMC members are considered binding. A vote passes if there are at least three binding +1s and more +1s than -1s.
Please remember that a binding +1 for GA implies that you intend to support the release by applying patches and responding to posts to the user and dev lists.
Sample Release Announcment
The Apache Struts team is pleased to announce the release of Struts #.#.# $GRADE.
Struts #.#.# is available in a full distribution, or as separate library, source, example and documentation distributions.
http://struts.apache.org/download.cgi#struts###
It is also available in the central Maven repository under Group ID "org.apache.struts".
The #.#.x series of the Apache Struts framework has a minumum requirement of the following specification versions:
- Java Servlet #.# and JavaServer Pages (JSP) #.#
- Java 2 Standard Platform Edition (J2SE) #.#
The release notes are available online at:
...