This guide comprises of all the steps to prepare, run a release and follow up on the next steps.
Add your gpg keys to KEYS before you do anything else.
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 version number in the main branch in a commit and push.
Example: https://github.com/apache/incubator-tuweni/commit/0330d134f579034b9d943870ea31316899632a11
In your release branch:
export BUILD_RELEASE=true
export ENABLE_SIGNING=true
./gradlew stage
Go to repository.apache.org and find the open repository that was created during the upload.
Click "Close" in the workflow buttons at the top.
Go to github.com, click tags and find your release.
Edit the tag and add release notes.
Make sure to mark the release as "pre-release".
Send an email to dev@tuweni.apache.org with the following:
Subject:[VOTE] Apache Tuweni ${RELEASE VERSION} release
We're voting on the source distributions available here:
https://dist.apache.org/repos/dist/dev/incubator/tuweni/${RELEASE VERSION}/
The release tag is present here:
https://github.com/apache/incubator-tuweni/releases/tag/v${RELEASE VERSION}-rc
Please review and vote as appropriate.
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.
The next step is to email the general incubator list. If 3 IPMC votes were collected in the first vote, this is a notification.
If less than 3 votes were collected, this email is a new vote asking for more IPMC +1s.
If a vote was called on the IPMC list, close it in the same fashion with a recap.
Go to github and mark the release as released. Change the tag name to drop the -rc
at the end.
Move the files from https://dist.apache.org/repos/dist/dev/incubator/tuweni/${RELEASE VERSION}/
to
https://dist.apache.org/repos/dist/release/incubator/tuweni/${RELEASE VERSION}/
:
svn move -m "Move Apache Tuweni ${RELEASE VERSION} to releases" https://dist.apache.org/repos/dist/dev/incubator/tuweni/${RELEASE VERSION} https://dist.apache.org/repos/dist/release/incubator/tuweni/${RELEASE VERSION}
Make sure to remove old releases from the dist site as well, to avoid clogging the servers.
svn rm -m "Remove old Tuweni release" https://dist.apache.org/repos/dist/release/incubator/tuweni/OLD_RELEASE
Go to repository.apache.org to the closed repository you closed during the RC process.
Click on it and press the release workflow button at the top.
Go to the repository here and perform this change:
Run ./publish.sh in the repository to publish the changes.
The email goes to dev@tuweni.apache.org, general@incubator.apache.org, and announce@apache.org. This email must be sent from an @apache.org email.
Subject: [ANNOUNCE] Apache Tuweni (incubating) ${RELEASE VERSION} released
The Apache Tuweni team is proud to announce the release of Apache Tuweni
(incubating) ${RELEASE VERSION}.
Apache Tuweni is a set of libraries and other tools to aid development of
blockchain and other decentralized software in Java and other JVM
languages. It includes a low-level bytes library, serialization and
deserialization codecs (e.g. RLP), various cryptography functions
and primatives, and lots of other helpful utilities. Tuweni is
developed for JDK 11 or higher, and depends on various other FOSS libraries.
Source and binary distributions can be downloaded from:
https://tuweni.apache.org/download
Release notes are at:
https://github.com/apache/incubator-tuweni/releases/tag/v${RELEASE VERSION}
A big thank you to all the contributors in this milestone release!
To learn more about Tuweni and get started:
http://tuweni.apache.org/
Thanks!
The Apache Tuweni Team
----
Disclaimer: Apache Tuweni is an effort undergoing incubation at The Apache
Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is
required of all newly accepted projects until a further review indicates
that the infrastructure, communications, and decision making process have
stabilized in a manner consistent with other successful ASF projects. While
incubation status is not necessarily a reflection of the completeness or
stability of the code, it does indicate that the project has yet to be
fully endorsed by the ASF.
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.