This guide comprises of all the steps to prepare, run a release and follow up on the next steps.
Open the file ~/.gradle/gradle.properties
and add the following information:
asfNexusUsername=${asf LDAP id} asfNexusPassword=${asf LDAP password} signing.keyId=${GPG key ID} signing.gnupg.keyName=${GPG key ID}
Make sure your computer has gpg utilities installed. Follow the Gradle signing plugin's GPG agent instructions to set up.
Create a new release branch formed with the major.minor
version numbers (see semver for glossary). For 1.0.0-SNAPSHOT
version, the release branch will therefore be 1.0
.
git checkout -b 1.0 git push origin 1.0
For patch releases, use the existing release branch.
Change the README file to update version numbers to the new release. Make a commit ($commitId) to the release branch and push. TODO : point to commit example
Change the version number in the master branch in a commit and push. TODO : point to commit example
Set up the version strategy:
export BUILD_RELEASE=true
Build the artifacts
./gradlew build
Check the sha512 signatures match
shasum -a 512 dist/build/distributions/tuweni-bin-${RELEASE VERSION}.tgz shasum -a 512 dist/build/distributions/tuweni-bin-${RELEASE VERSION}.zip shasum -a 512 dist/build/distributions/tuweni-src-${RELEASE VERSION}.tgz shasum -a 512 dist/build/distributions/tuweni-src-${RELEASE VERSION}.zip shasum -a 512 dist/build/distributions/tuweni-gossip-${RELEASE VERSION}.tgz shasum -a 512 dist/build/distributions/tuweni-gossip-${RELEASE VERSION}.zip
Sign and publish
export ENABLE_SIGNING=true ./gradlew publish
This checks the code, the licenses, runs all the tests and creates all the artifacts (binaries, sources, javadoc).
This also publishes the artifacts to repository.apache.org in a staging repository.
If necessary create the folder:
svn mkdir -m "Add new Tuweni folder for release ${RELEASE VERSION}" https://dist.apache.org/repos/dist/dev/tuweni/${RELEASE VERSION}
Check out the folder locally:
svn checkout https://dist.apache.org/repos/dist/dev/tuweni/${RELEASE VERSION} _staged
Delete contents of the folder if necessary.
TODO
Copy the distribution artifacts to it - make sure to change the name to ${RELEASE VERSION}-incubating:
cp dist/build/distributions/tuweni-${RELEASE VERSION}.zip _staged/tuweni-${RELEASE VERSION}-incubating.zip cp dist/build/distributions/tuweni-${RELEASE VERSION}.tgz _staged/tuweni-${RELEASE VERSION}-incubating.tgz
Commit the changes
cd _staged svn add tuweni-* svn ci -m "Add Apache Tuweni ${RELEASE VERSION} release candidate"
git tag -m "Release ${RELEASE VERSION}" v${RELEASE VERSION} git push origin 1.0 --tags
Send an email to dev@tuweni.apache.org with the following:
Subject:[VOTE] Tuweni ${RELEASE VERSION} release
We're voting on the source distributions available here: https://dist.apache.org/repos/dist/dev/tuweni/${RELEASE VERSION}/dist/ Specifically: https://dist.apache.org/repos/dist/dev/tuweni/${RELEASE VERSION}/dist/tuweni-${RELEASE VERSION}.tgz https://dist.apache.org/repos/dist/dev/tuweni/${RELEASE VERSION}/dist/tuweni-${RELEASE VERSION}.zip The documentation generated for this release is available here: https://dist.apache.org/repos/dist/dev/tuweni/${RELEASE VERSION}/site/ The following changes were made since ${PREVIOUS VERSION}: ${fill in changes}
The vote should be opened for at least 72 hours, longer if there is a week-end.
After the time of the vote has elapsed, close the vote thread with a recap showing the votes.
TODO
TODO
TODO
Subject: [ANNOUNCE] Apache Tuweni ${RELEASE VERSION} released ${TUWENI DESCRIPTION} New in this release: ${list of changes} To learn more about Tuweni and get started: http://tuweni.apache.org/ Thanks! The Apache Tuweni Team
See $commitId above.
git cherry-pick ${commitId}
If applicable mark the version as released.
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.