...
We're
...
starting
...
to
...
move
...
our
...
builds
...
over
...
to
...
using
...
the
...
Apache
...
Nexus
...
repository
...
(repository.apache.org)
...
for
...
releasing
...
SNAPSHOT
...
and
...
release
...
artifacts.
...
More
...
details
...
on
...
releasing
...
artifacts
...
and
...
using
...
Nexus
...
can
...
be
...
found
...
on
...
the
...
Maven
...
website
...
at
...
-
...
http://maven.apache.org/developers/release/apache-release.html
...
Release Steps for OpenJPA 1.3.x
...
-
...
2.1.x
...
- Environment
...
- setup
...
- for
...
- releasing
...
- artifacts
...
- (same
...
- for
...
- SNAPSHOTs
...
- and
...
- releases)
...
- -
...
- Increase
...
- the
...
- default
...
- Java
...
- heap
...
- available
...
- to
...
- Maven
...
- (required
...
- for
...
- Java
...
- SE
...
- 6)
...
Code Block none none export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m"
...
- Use the latest Sun 1.6.0
...
- JDK
...
- Use
...
- Maven
...
- 2.2.1
...
- or
...
- later
...
- (2.2.1
...
- is
...
- required
...
- for
...
- release
...
- signing
...
- fixes)
...
- Make
...
- sure
...
- the
...
- Release Setup steps have been performed.
- Prepare the source for release:
- Cleanup JIRA so the Fix Version in issues resolved since the last release includes this release version correctly. Also, transition any Resolved issues to the Closed state.
- Update the text files in a working copy of the openjpa-project subdir -
- Update the CHANGES.txt based on the Text release reports from JIRA.
- Update the RELEASE-NOTES.html based on the HTML release reports from JIRA.
- Review and update README.txt and BUILDING.txt if needed.
- Commit any changes back to svn -
Code Block none none $ svn commit -m "updating files for release"
...
- Stage any Roadmap or Release landing pages on the wiki.
- Use "mvn apache-rat:check"
...
- to
...
- verify
...
- the
...
- source
...
- has
...
- the
...
- required
...
- headers
...
- before
...
- trying
...
- to
...
- release.
...
- Perform
...
- a
...
- full
...
- build
...
- with
...
- tests
...
Code Block none none $ mvn clean install -Papache-release,docbook-profile,test-derby,bval
...
- Run the JPA 1.0
...
- and
...
- JPA
...
- 2.0
...
- TCKs
...
- to
...
- verify
...
- the
...
- latest
...
- code
...
- passes.
...
- Perform a full build and deploy the SNAPSHOT artifacts
Code Block none none $ mvn clean deploy site site-deploy -Papache-release,docbook-profile,test-derby,bval -DskipTests
- Perform a full build and deploy the SNAPSHOT artifacts
...
- Inspect the files in your local target directories to ensure:
- All jars and zips include: LICENSE and NOTICE files
- The NOTICE files cover all third-party included files (like XSD schemas)
- The LICENSE files include any third-party licenses (like XSD schemas)
- The openjpa and openjpa-all jars include the right packages.
- The openjpa source and release distribution files have the right content.
- All jars/zips/poms have .asc (PGP signature) and md5 files
- For new major releases (like 2.0.0 to 2.1.0)
- Create a sub-branch from which to make the release. Releasing from a branch will allow any cosmetic changes that need to be made for the release to be approved to be done without preventing other more disruptive advances in the trunk from potentially causing problems with the release. It also provides a future maintenance branch (like 2.0.x.)
...
- A
...
- branch
...
- can
...
- be
...
- made
...
- by
...
- running:
...
Code Block none none $ mvn release:branch -DbranchName=2.0.x
...
- Checkout a clean copy of the trunk/branch
...
- to
...
- release
...
- using
...
- command
...
- line
...
- svn.
...
- Do
...
- not
...
- use
...
- Eclipse
...
- to
...
- do
...
- the
...
- checkout.
...
- The
...
- extra
...
- dot
...
- (.)
...
- files
...
- created
...
- by
...
- Eclipse
...
- throws
...
- off
...
- the
...
- rat:check
...
- processing
...
- and
...
- will
...
- get
...
- included
...
- in
...
- the
...
- source
...
- distribution.
...
Code Block none none $ svn checkout https://svn.apache.org/repos/asf/openjpa/2.0.x/ 2.0.1-rc1/
...
- (Optional)
...
- Do
...
- a
...
- dry
...
- run
...
- of
...
- the
...
- release:prepare
...
- step.
...
- The
...
- dry
...
- run
...
- will
...
- not
...
- commit
...
- any
...
- changes
...
- back
...
- to
...
- SVN
...
- and
...
- gives
...
- you
...
- the
...
- opportunity
...
- to
...
- verify
...
- that
...
- the
...
- release
...
- process
...
- will
...
- complete
...
- as
...
- expected.
...
- You
...
- will
...
- be
...
- prompted
...
- for
...
- the
...
- following
...
- information
...
- :
...
- Release
...
- version
...
- -
...
- take
...
- the
...
- default
...
- -
...
- (default
...
- 2.0.1)
...
- SCM
...
- release
...
- tag
...
- -
...
- *DO
...
- NOT
...
- TAKE
...
- THE
...
- DEFAULT
...
- -
...
- (default
...
- openjpa-parent-2.0.1):
...
- :
...
- 2.0.1
...
- New
...
- development
...
- version
...
- -
...
- take
...
- the
...
- default
...
- -
...
- (default
...
- 2.0.2-SNAPSHOT)
...
- optional if you have not specified a GPG passphrase in settings.xml
...
- you
...
- will
...
- be
...
- prompted
...
- for
...
- it.
...
Code Block none none $ mvn -Papache-release release:prepare -DdryRun=true
...
Note If you cancel a release:prepare
...
before
...
it
...
updates
...
the
...
pom.xml
...
versions,
...
then
...
use
...
the
...
release:clean
...
goal
...
to
...
just
...
remove
...
the
...
extra
...
files
...
that
...
were
...
created.
...
- Verify that the release process completed as expected
- The release plugin will create pom.xml.tag
...
- files
...
- which
...
- contain
...
- the
...
- changes
...
- that
...
- would
...
- have
...
- been
...
- committed
...
- to
...
- SVN.
...
- The
...
- only
...
- differences
...
- between
...
- pom.xml.tag
...
- and
...
- it's
...
- corresponding
...
- pom.xml
...
- file
...
- should
...
- be
...
- the
...
- version
...
- number.
...
- If
...
- other
...
- formatting
...
- changes
...
- have
...
- been
...
- made
...
- you
...
- should
...
- review
...
- the
...
- changes
...
- and
...
- then
...
- commit
...
- them
...
- -
...
Code Block none none $ svn commit -m "fixing formatting for release"
...
- Assuming the .tag
...
- files
...
- look
...
- OK
...
- you
...
- may
...
- proceed
...
- and
...
- do
...
- any
...
- other
...
- validation
...
- you
...
- feel
...
- necessary.
...
- The
...
- following
...
- list
...
- may
...
- be
...
- helpful
...
- Check
...
- release.properties
...
- and
...
- make
...
- sure
...
- that
...
- the
...
- scm
...
- properties
...
- have
...
- the
...
- right
...
- version.
...
- Sometimes
...
- the
...
- scm
...
- location
...
- can
...
- be
...
- the
...
- previous
...
- version
...
- not
...
- the
...
- next
...
- version.
...
- verify
...
- signatures
...
...
...
...
- Once
...
- any
...
- failures
...
- or
...
- required
...
- updates
...
- have
...
- been
...
- committed
...
- to
...
- svn,
...
- rollback
...
- the
...
- release
...
- prepare
...
- files
...
- -
...
Code Block none none $ mvn -Papache-release release:rollback
...
- Prepare the release
- Run the "release:prepare"
...
- step
...
- for
...
- real
...
- this
...
- time.
...
- You'll
...
- be
...
- prompted
...
- for
...
- the
...
- same
...
- version
...
- information
...
- and
...
- optionally
...
- your
...
- GPG
...
- passphrase
...
- again.
...
Note
...
Different
...
arguments
...
and
...
steps
...
are
...
required
...
as
...
there
...
are
...
problems
...
with
...
the
...
maven-jar-plugin
...
and
...
maven-release-plugin
...
when
...
using
...
the
...
test-jar
...
goal.
...
See
...
...
and
...
...
.
Code Block none none $ mvn release:prepare -Papache-release,docbook-profile,test-derbymem,bval -DskipTests -DpreparationGoals="clean install"
...
- Backup (zip
...
- or
...
- tar)
...
- your
...
- local
...
- release
...
- candidate
...
- directory
...
- in
...
- case
...
- you
...
- need
...
- to
...
- rollback
...
- the
...
- release
...
- after
...
- the
...
- next
...
- step
...
- is
...
- performed.
...
Code Block none none cd .. tar -czf 2.0.1-rc1-preRelease.tar.gz 2.0.1-rc1/ cd 2.0.1-rc1
...
- Perform the release
- This step will create a maven staging repository and site for use in testing and voting. You will be prompted for your repository.apache.org
...
- and
...
- people.apache.org
...
- password
...
- several
...
- times
...
- if
...
- you
...
- have
...
- not
...
- added
...
- server
...
- profiles
...
- to
...
- your
...
- settings.xml.
...
- See
...
...
...
- for
...
- more
...
- information.
...
Code Block none none $ mvn release:perform -Papache-release -Duser.name=<your_apache_uid>
...
Note If your local OS userid doesn't
...
match
...
your
...
Apache
...
userid,
...
then
...
you'll
...
have
...
to
...
also
...
override
...
the
...
value
...
provided
...
by
...
the
...
OS
...
to
...
Maven
...
for
...
the
...
site-deploy
...
step
...
to
...
work.
...
This
...
is
...
known
...
to
...
work
...
for
...
Linux,
...
but
...
not
...
for
...
Mac
...
and
...
unknown
...
for
...
Windows.
...
- The maven-release-plugin
...
- is
...
- configured
...
- with
...
- goals
...
- "deploy
...
- site
...
- site-deploy"
...
- and
...
- will
...
- deploy
...
- the
...
- site
...
- files
...
- to
...
- a
...
- staging-site
...
- directory
...
- on
...
- people.apache.org.
...
- Verify
...
- the
...
- release
...
- artifacts
...
- Verify
...
- the
...
- HTML
...
- links
...
- in
...
- staging-site/index.html
...
- are
...
- correct
...
- Update
...
- downloads/
...
- to
...
- apache-openjpa/downloads/
...
- Update
...
- docs/index.html
...
- to
...
- apache-openjpa/docs/index.html
...
- Verify the staged artifacts in the nexus repo
...
...
- -->
...
- Staging
...
- Staging
...
- tab
...
- -->
...
- Name
...
- column
...
- -->
...
- org.apache.openjpa
...
- Navigate
...
- through
...
- the
...
- artifact
...
- tree
...
- and
...
- make
...
- sure
...
- that
...
- all
...
- javadoc,
...
- sources,
...
- tests,
...
- jars,
...
- ...
...
- have
...
- .asc
...
- (GPG
...
- signature)
...
- and
...
- .md5
...
- files.
...
- See
...
...
- and
...
...
- Close
...
- the
...
- nexus
...
- staging
...
- repo
...
...
...
- -->
...
- Staging
...
- Staging
...
- tab
...
- -->
...
- Name
...
- column
...
- -->
...
- org.apache.openjpa
...
- Right
...
- click
...
- on
...
- the
...
- open
...
- staging
...
- repo
...
- (org.apache.openjpa-XXX)
...
- and
...
- select
...
- Close.
...
- Put
...
- the
...
- release
...
- candidate
...
- up
...
- for
...
- a
...
- vote
...
- Create
...
- a
...
- VOTE
...
...
- thread
...
- on
...
- dev@openjpa
...
- to
...
- record
...
- votes
...
- as
...
- replies,
...
- like
...
- -
...
Code Block none none To: dev@ Subject: [VOTE] Apache OpenJPA 2.0.1 Release Candidate I've created a 2.0.1 release candidate, with the following artifacts up for a vote: SVN source tag (rXXXXXX): https://svn.apache.org/repos/asf/openjpa/tags/2.0.1/ Maven staging repo: https://repository.apache.org/content/repositories/orgapacheopenjpa-XXX/ Source release: https://repository.apache.org/content/repositories/orgapacheopenjpa-XXX/org/apache/openjpa/openjpa-parent/2.0.1/openjpa-parent-2.0.1-source-release.zip Javadoc staging site: http://people.apache.org/~dwoods/openjpa/2.0.1/staging-site/apidocs/ PGP release keys (signed using D018E6B1): https://svn.apache.org/repos/asf/openjpa/KEYS Vote will be open for 72 hours. [ ] +1 approve [ ] +0 no opinion [ ] -1 disapprove (and reason why)
...
- Create a DISCUSS email thread on dev@ for any vote questions, like -
Code Block none none To: dev@ Subject: [DISCUSS] Apache OpenJPA 2.0.1 Release Candidate Discussion thread for vote on 2.0.1 release candidate, with SVN source tag (rXXXXXX). For more information on the release process, checkout - http://www.apache.org/dev/release.html http://incubator.apache.org/guides/releasemanagement.html Some of the things to check before voting are: - does "mvn apache-rat:check" pass on the source - can you build the contents of source-release.zip and svn tag - do all of the staged jars/zips contain the required LICENSE and NOTICE files - are all of the staged jars signed and the signature verifiable - is the signing key in the project's KEYS file and on a public server - does the release pass the TCK
...
- Perform a review of the release and cast your vote. See the following for more details on Apache releases -
...
...
- A
...
- -1
...
- vote
...
- does
...
- not
...
- necessarily
...
- mean
...
- that
...
- the
...
- vote
...
- must
...
- be
...
- redone,
...
- however
...
- it
...
- is
...
- usually
...
- a
...
- good
...
- idea
...
- to
...
- rollback
...
- the
...
- release
...
- if
...
- a
...
- -1
...
- vote
...
- is
...
- received.
...
- See
...
- -
...
...
...
...
...
...
- After
...
- the
...
- vote
...
- has
...
- been
...
- open
...
- for
...
- at
...
- least
...
- 72
...
- hours,
...
- has
...
- at
...
- least
...
- three
...
- +1
...
- PMC
...
- votes
...
- and
...
- no
...
- -1
...
- votes,
...
- then
...
- post
...
- the
...
- results
...
- to
...
- the
...
- vote
...
- thread
...
- by
...
- -
...
- reply
...
- to
...
- the
...
- initial
...
...
- and
...
- prepend
...
- to
...
- the
...
- original
...
- subject
...
- -
...
Code Block none none [RESULTS]
...
- Include a list of everyone who voted +1,
...
- 0
...
- or
...
- -1.
...
- Finalizing
...
- a
...
- release
...
- Promote
...
- the
...
- staged
...
- nexus
...
- artifacts
...
- -
...
...
...
- -->
...
- Staging
...
- Staging
...
- tab
...
- -->
...
- Name
...
- column
...
- -->
...
- org.apache.openjpa
...
- Right
...
- click
...
- on
...
- the
...
- closed
...
- staging
...
- repo
...
- (org.apache.openjpa-XXX)
...
- and
...
- select
...
- Promote.
...
- Copy
...
- the
...
- staged
...
- site
...
- over
...
- to the openjpa/builds location on people.apache.org.
- ssh to people.apache.org
Code Block none none $ mkdir /www/openjpa.apache.org/builds/2.0.1 $ cp -r ~/public_html/openjpa/2.0.1/staging-site/* /www/openjpa.apache.org/builds/2.0.1/ $ chmod -R g+w /www/openjpa.apache.org/builds/2.0.1
- Update the assemblies in the Downloads directory.
For this, we'll just wget copies of the released assemblies with their signatures and hashes from the Apache repo:
Along with the *.zip.asc, *.zip.md5 and *.zip.sha1 for both ZIP files above.Code Block none none $ cd /www/openjpa.apache.org/builds/2.0.1/apache-openjpa/downloads wget https://repository.apache.org/content/repositories/releases/org/apache/openjpa/apache-openjpa/2.0.1/apache-openjpa-2.0.1-source.zip wget https://repository.apache.org/content/repositories/releases/org/apache/openjpa/apache-openjpa/2.0.1/apache-openjpa-2.0.1-binary.zip
- verify that /www/openjpa.apache.org/builds/2.0.1/docs/manual is populated correctly by comparing it to a previous release.
Code Block none none $ rm /www/openjpa.apache.org/docs/latest $ ln -fvs ../builds/2.0.1/apache-openjpa/docs/ /www/openjpa.apache.org/docs/latest
- ssh to people.apache.org
- Copy the distribution artifacts over to the distribution area.
Code Block none none mkdir /www/www.apache.org/dist/openjpa/2.0.1 cp /www/openjpa.apache.org/builds/2.0.1/apache-openjpa/downloads/* /www/www.apache.org/dist/openjpa/2.0.1/ chgrp -R openjpa /www/www.apache.org/dist/openjpa/2.0.1 chmod -R g+w /www/www.apache.org/dist/openjpa/2.0.1
- Optional: Remove the previous version from /dist. Ie if you're publishing 2.0.1 you would remove 2.0.0.
Code Block none none $ rm -rf /www/openjpa.apache.org/dist/openjpa/2.0.1
- Optional: Remove the previous version from /dist. Ie if you're publishing 2.0.1 you would remove 2.0.0.
- Update the Downloads and Documentation pages with the new release
- Update the JIRA versions page to mark the version as "released", and set the date to the date that the release was approved. You may also need to make a new release entry for the next release.
- to the openjpa/builds location on people.apache.org.
- Announcing the release
- After the Maven mirrors have had time to update (24 hours to be on the safe side) update the wiki with pointers to the new release
- Make a news announcement on the OpenJPA wiki.
- Make an announcement about the release on the dev@, user@ and announce@apache.org list as per the Apache Announcement Mailing Lists page)
Recovering from a vetoed release
- Reply to the initial vote email and prepend to the original subject -
Code Block none none [CANCELED]
- Rollback the version upgrades in trunk by either -
- Restore the 2.0.1-rc1.tar.gz
...
- and
...
- run
...
Code Block none none $ mvn -Papache-release release:
...
rollback
- Manually revert the versions in trunk to the prior version and commit
- Delete the svn tag created by the release:perform step -
Code Block none none $ svn del https://svn.apache.org/repos/asf/openjpa/tags/2.0.1 -m "rollback release attempt"
...
- Drop the nexus staging repo
...
...
- -->
...
- Staging
...
- Staging
...
- tab
...
- -->
...
- Name
...
- column
...
- -->
...
- org.apache.openjpa
...
- Right
...
- click
...
- on
...
- the
...
- closed
...
- staging
...
- repo
...
- (org.apache.openjpa-XXX)
...
- and
...
- select
...
- Drop.
...
- Remove
...
- the
...
- staged
...
- site
...
Code Block none none $ ssh ${user.name}@people.apache.org $ cd ~/public_html/openjpa $ rm -fr ${project.version}
- Make the required updates that caused the vote to be canceled
- Spin another release candidate!
Verifying release signatures
On unix platforms the following command can be executed -
Code Block | ||||
---|---|---|---|---|
| ||||
{code} # Make the required updates that caused the vote to be canceled # Spin another release candidate! \\ h3. Verifying release signatures On unix platforms the following command can be executed - {code:none} for file in `find . -type f -iname '*.asc'` do gpg --verify ${file} done {code} |
You'll
...
need
...
to
...
look
...
at
...
the
...
output
...
to
...
ensure
...
it
...
contains
...
only
...
good
...
signatures
...
-
Code Block | ||||
---|---|---|---|---|
| ||||
{code:none} gpg: Good signature from ... gpg: Signature made ... {code} \\ |