Useful Links
- Setting up release signing keys
- Uploading artifacts to staging and release repositories
- Release requirements
- Process for staging
...
Preparing for release
Setup for first time release managers
If you are being a release manager for the first time, you will need to run the following additional steps so that you are not blocked during the actual release process.
Configure SSH/SFTP to peoplehome.apache.org
SSH SFTP to peoplehome.apache.org supports only Key-Based SSH Logins
Code Block | ||
---|---|---|
| ||
# Generate RSA Keys mkdir ~/.ssh chmod 700 ~/.ssh ssh-keygen -t rsa -b 4096 # Note: This will create ~/.ssh/id_rsa and ~/.ssh/id_rsa.pub files will be generated # Upload Public RSA Key Login at http://id.apache.org Add Public SSH Key to your profile from ~/.ssh/id_rsa.pub SSH Key (authorized_keys line): Submit changes # Verify SSH to peopleminotaur.apache.org works ssh -i ~/.ssh/id_rsa {username}@people@minotaur.apache.org mkdir # SFTP to home.apache.org sftp {username}@home.apache.org mkdir public_html cd public_html touch testput test #This test file is a sample empty file present in current working directory from which you sftp. Verify URL http://peoplehome.apache.org/{username}/test |
Generate OpenGPG Key
You should get a signing key, keep it in a safe place, upload the public key to apache, and build a web of trust.
Code Block | ||
---|---|---|
| ||
gpg2 --gen-key gpg2 --keyserver pgp.mit.edu --send-key {key} gpg2 --armor --export {username}@apache.org > {username}.asc scpCopy over {username}.asc to {username}@people@home.apache.org:public_html/~{username}.asc Verify URL http://peoplehome.apache.org/~{username}/{username}.asc Query PGP KeyServer http://pgp.mit.edu:11371/pks/lookup?search=0x{key}&op=vindex Web of Trust: Request others to sign your PGP key. Login at http://id.apache.org Add OpenPGP Fingerprint to your profile OpenPGP Public Key Primary Fingerprint: XXXX YYYY ZZZZ .... Submit changes Verify that the public PGP key is exported to http://peoplehome.apache.org/keys/committer/{username}.asc |
Email dev@ambari.apache.org mailing list notifying that you will be creating the release branch at least one week in advance
Code Block | ||
---|---|---|
| ||
Subject: Preparing Ambari X.Y.Z branch Hi developers and PMCs, I am proposing cutting a new branch branch-X.Y for Ambari X.Y.Z on __________ as per the outlined tasks in the Ambari Feature + Roadmap page (https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=30755705). After making the branch, we (i.e., development community) should only accept blocker or critical bug fixes into the branch and harden it until it meets a high enough quality bar. If you have a bug fix, it should first be committed to trunk, and after ensuring that it does not break any tests (including smoke tests), then it should be integrated to the Ambari branch-X.Y If you have any doubts whether a fix should be committed into branch-X.Y, please email me for input at ____________ Stay tuned for updates on the release process. Thanks |
Create the release branch
Create a branch for a release using branch-X.Y (ex: branch-2.1) as the name of the branch.
Note: Going forward, we should be creating branch-{majorVersion}.{minorVersion), so that the same branch can be used for maintenance releases.
Checkout the release branch
Code Block | ||
---|---|---|
| ||
git checkout branch-X.Y |
Update
...
Ambari REST API docs
Starting with Ambari's trunk
branch as of Ambari 2.8, the release manager should generate documentation from existing source code. The documentation should be checked back into the branch before performing the release.
Code Block | ||
---|---|---|
| ||
# Generate the following artifacts:
# - Configuration markdown at docs/configuration/index.md
# - swagger.json and index.html at docs/api/generated/
cd ambari-server/
mvn clean compile exec:java@configuration-markdown test -Drat.skip -Dcheckstyle.skip -DskipTests -Dgenerate.swagger.resources
# Review and Commit the changes to branch-X.Y
git commit |
Update release version
Once the branch has been created, the release version must be set and committed. The changes should be committed to the release branch.
Ambari 2.8+
Starting with Ambari 2.8, the build process relies on Maven 3.5+ which allows the use of the ${revision}
tag. This means that the release version can be defined once in the root pom.xml
and then inherited by all submodules. In order to build Ambari with a specific build number, there are two methods:
mvn -Drevision=2.8.0.0.0 ...
- Editing the root
pom.xml
to include the new build number<revision>2.8.0.0-SNAPSHOT</revision>
To be consistent with prior releases, the pom.xml
should be updated in order to contain the new version.
Code Block | ||||
---|---|---|---|---|
| ||||
# Update the revision property to the release version
mvn versions:set-property -Dproperty=revision -DnewVersion=2.8.0.0.0
# Remove .versionsBackup files
git clean -f -x
# Review and commit the changes to branch-X.Y
git commit |
Ambari 2.7 and Earlier Releases (Deprecated)
Older Ambari branches still required that you update every pom.xml
manually through the below process:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
# Update the release version
mvn versions:set -DnewVersion=2.2.0.0.0
pushd ambari-metrics
mvn versions:set -DnewVersion=2.2.0.0.0
|
Make sure once the branch is created the version is set as appropriate. Make sure that all versions are updated. Commit the changes to the release branch.
Code Block |
---|
Steps followed for 2.2.0 release as a reference
# Update the release version
mvn versions:set -DnewVersion=2.2.0.0.0
pushd ambari-metrics
mvn versions:set -DnewVersion=2.2.0.0.0
popd
pushd contrib/ambari-log4j
mvn versions:set -DnewVersion=2.2.0.0.0
popd
pushd contrib/ambari-scom
mvn versions:set -DnewVersion=2.2.0.0.0
popd
pushd docs
mvn versions:set -DnewVersion=2.2.0.0.0
popd
# Update the ambari.version properties in all pom.xml
$ find . -name "pom.xml" | xargs grep "ambari\.version"
./contrib/ambari-scom/ambari-scom-server/pom.xml: <ambari.version>2.1.0-SNAPSHOT</ambari.version>
./contrib/ambari-scom/ambari-scom-server/pom.xml: <version>${ambari.version}</version>
./contrib/views/hive/pom.xml: <ambari.version>2.1.0.0.0</ambari.version>
./contrib/views/jobs/pom.xml: <version>${ambari.version}</version>
./contrib/views/pig/pom.xml: <ambari.version>2.1.0.0.0</ambari.version>
./contrib/views/pom.xml: <ambari.version>2.1.0.0.0</ambari.version>
./contrib/views/storm/pom.xml: <version>${ambari.version}</version>
./contrib/views/tez/pom.xml: <version>${ambari.version}</version>
./docs/pom.xml: <ambari.version>2.1.0</ambari.version>
./docs/pom.xml: <final.name>${project.artifactId}-${ambari.version}</final.name>
# Update any 2.1.0-SNAPSHOT references in pom.xml
$ grep -r --include "pom.xml" "2.1.0-SNAPSHOT" .
# Remove .versionsBackup files
git clean -f -x -d
# Review and commit the changes to branch-X.Y
git commit |
...
If this is the first time you have taken release management responsibilities, make sure to update the KEYS file and commit the updated KEYS in both the ambari trunk branch and the release branch. Also in addition to updating the KEYS file in the tree, you also need to push the KEYS file to https://dist.apache.org/repos/dist/release/ambari/
Code Block | ||||
---|---|---|---|---|
| ||||
#update the KEYS file gpg2 --list-keys jluniya@apache.org >> KEYS gpg2 --armor --export jluniya@apache.org >> KEYS # commit the changes to both trunk and new release branch git commit # push the updated KEYS file to https://dist.apache.org/repos/dist/release/ambari//release/ambari/. # Only PMCs members can do this 'svn' step. svn co https://dist.apache.org/repos/dist/release/ambari ambari_svn cp {path_to_keys_file}/KEYS ambari_svn/KEYS svn update KEYS svn commit -m "Updating KEYS for Ambari" |
...
Checkout the release branch
Code Block |
---|
git checkout branch-X.Y
|
Create a Release Tag from the release branch
| ||
git checkout branch | ||
Code Block | ||
---|---|---|
git tag -a release-X.Y.Z-rc0 -m 'Ambari X.Y.Z RC0' git push origin release-X.Y.Z-rc0 |
Create a
...
Release Tag from the release branch
Code Block | ||
---|---|---|
| ||
git #tag create -a clean copy of the source cd ambari-gitrelease-X.Y.Z git clean -f -x -d cd .. cp -R ambari-git--rc0 -m 'Ambari X.Y.Z apache-ambari-RC0' git push origin release-X.Y.Z-rc0 |
Create a tarball
Code Block | ||
---|---|---|
| ||
src # create ambari-web/public by running the build instructions per https://cwiki.apache.org/confluence/display/AMBARI/Ambari+Development # once ambari-web/public is created, copy it as ambari-web/public-statica clean copy of the source cd ambari-git-X.Y.Z git clean -f -x -d cd .. cp -R ambari-git-X.Y.Z/ambari-web/public apache-ambari-X.Y.Z-src/ # create ambari-web/public-static #by makerunning surethe apachebuild ratinstructions tool runs successfully cp -R apache-ambari-X.Y.Z-src apache-ambari-X.Y.Z-ratcheck cd apache-ambariper https://cwiki.apache.org/confluence/display/AMBARI/Ambari+Development # once ambari-web/public is created, copy it as ambari-web/public-static cp -R ambari-git-X.Y.Z-ratcheck mvn clean apache-rat:check cd .. # if rat check fails, file JIRAs and fix them before proceeding./ambari-web/public apache-ambari-X.Y.Z-src/ambari-web/public-static # tarmake itsure up,apache butrat excludetool gitruns artifactssuccessfully tarcp --exclude=.gitR apache-ambari-exclude=.gitignore --exclude=.gitattributes -zcvfX.Y.Z-src apache-ambari-X.Y.Z-ratcheck cd apache-ambari-X.Y.Z-src.tar.gzratcheck mvn clean apache-ambari-X.Y.Z-src |
Sign the tarball
Code Block |
---|
gpg2 --armor --output apache-ambari-X.Y.Z-src.tar.gz.asc --detach-sig apache-ambari-X.Y.Z-src.tar.gz
|
Generate MD5 checksums:
Code Block |
---|
md5sumrat:check cd .. # if rat check fails, file JIRAs and fix them before proceeding. # tar it up, but exclude git artifacts tar --exclude=.git --exclude=.gitignore --exclude=.gitattributes -zcvf apache-ambari-X.Y.Z-src.tar.gz > apache-ambari-X.Y.Z-src |
Sign the tarball
Code Block | ||
---|---|---|
| ||
gpg2 --armor --output.tar.gz.md5 sha1sum apache-ambari-X.Y.Z-src.tar.gz >.asc --detach-sig apache-ambari-X.Y.Z-src.tar.gz.sha1 |
...
Generate SHA512 checksums:
Code Block | ||
---|---|---|
| ||
sha512sumopenssl md5 apache-ambari-X.Y.Z-src.tar.gz > apache-ambari-X.Y.Z-src.tar.gz.md5 sha512 |
or
Code Block | ||
---|---|---|
| ||
openssl sha1sha512 apache-ambari-X.Y.Z-src.tar.gz > apache-ambari-X.Y.Z-src.tar.gz.sha1 sha512 |
Upload the artifacts to your apache home:
The artifacts then need to be copied over (SFTP) to
Code Block | ||
---|---|---|
| ||
public_html/apache-ambari-X.Y.Z-rc0 |
...
I have created an ambari-** release candidate.
GIT source tag (r***)
Code Block | ||
---|---|---|
| ||
https://git-wip-us.apache.org/repos/asf/ambari/repo?p=ambari.git;a=log;h=refs/tags/release-x.y.z-rc0 |
Staging site: http://peoplehome.apache.org/user_name/apache-ambari-X.Y.Z-rc0
PGP release keys (signed using 8EE2F25C) http://pgp.mit.edu:11371/pks/lookup?op=vindex&search=0x0DFF492D8EE2F25C
...
Publish the release as below:
Code Block | ||||
---|---|---|---|---|
| ||||
svn co https://dist.apache.org/repos/dist/release/ambari ambari /release/ambari ambari # Note : Only PMCs members can do this 'svn' step. cd ambari mkdir ambari-X.Y.Z scp ~/public_html/apache-ambari-X.Y.Z-rc0/* ambari-X.Y.Z svn add ambari-X.Y.Z* ambari-X.Y.Z svn add ambari-X.Y.Z svn rm ambari-A.B.C # Remove the older release from the mirror. Only the latest version should appear in dist. svn commit -m "Committing Release X.Y.Z" |
Create the release tag:
Code Block | ||||
---|---|---|---|---|
| ||||
git tag -a release-X.Y.Z -m 'Ambari X.Y.Z' git push origin release-X.Y.Z |
...
http://ambari.apache.org is checked in Git in /ambari/docs/src/site folder.
Code Block | ||
---|---|---|
| ||
cd docs
mvn versions:set -DnewVersion=X.Y.Z
# Make necessary changes, typically to pom.xml, site.xml, index.apt, and whats-new.apt
mvn clean site |
...
Performing this step keeps https://reporter.apache.org/?ambari site updated and people using the Apache Reporter Service will be able to see the latest release data for Ambari.
Publish Ambari artifacts to Maven central
Please use the following document to publish Ambari artifacts to Maven central.