Outlines the steps used to create a new Trafodion release. You have to be a Trafodion PMC member to create a release.


Create PGP Key

If you haven’t done so already, then you need to create a PGP key so that you can sign the release. Please refer to:http://www.apache.org/dev/openpgp.html#generate-key.


Please remember to store your private key in a secure place.

gpg --gen-key   (verify that sha1 is avoided (last on list - see above web site)
gpg -k  (shows public key)
gpg -K (shows private key)

Upload Public Key

Upload your public key to a public key server. We recommend using https://pgp.mit.edu/.

gpg --send-keys <keyID> --keyserver pgp.mit.edu

Generate Revocation Certificate

Create a revocation certification using the instructions at: http://www.apache.org/dev/openpgp.html==revocation-certs.

 

Please remember to store it in a secure place separate from your PGP keys.

gpg --output revoke-<keyID>.asc --armor --gen-revoke <keyID>

Add PGP to KEYS File

Do the following:

svn co https://dist.apache.org/repos/dist/release/trafodion traf_release
cd traf_release
gpg --list-sigs <keyID> >> KEYS
gpg  --armor --export <keyID> >> KEYS
svn commit -m "added new public key to KEYS file"
 
Now do the same steps above  for the dev repository too : https://dist.apache.org/repos/dist/dev/trafodion

Get Your Key Signed

Link into the "Web of Trust" by having someone else sign your key. 

You can sign other people's keys, but you must verify their identity in person and make sure the key fingerprint matches. See ASF guide for more info.

Prepare For Release

Prepare New Release

  1. Send a message out to the community indicating that a new release is being planned. In this message, indicate what is planned for the release and when the release is scheduled.
  2. Give contributors enough time to assimilate this information so they can make plans to deliver their changes. Recommend giving the community several weeks notice.
  3. Review open issues and planned features; determine what Jiras should be included in the release.

Verify Release Requirements

You need to ensure that:

  • NOTICE and LICENSE files exist in the top level directory which includes all third party licenses used in the product. Please refer to: http://www.apache.org/dev/licensing-howto.html.
  • A README file exists and is up to date in the top level directory describing the release.
  • The source release contains source code only, no binaries.
  • The provenance of all source files is clear.
  • All source files have Apache license headers, where possible. Where not possible, then the exceptions are written up in the RAT_README file located in the top level directory.
  • RAT report is clean.
  • Copyright dates are current.
  • Build instructions are provided and can be run successfully.
  • Test instructions are provided and can be run successfully.

Create Release Branch

Prior to releasing, send a message to the community indicating that a new release is imminent and that a new branch will be created to build the artifacts.

git branch release2.0 apache/master
git push apache release2.0:release2.0


Make sure that check-in automated testing is set up for new release.

After the new release branch is created, send another message to the community indicating that the branch is available and the deliveries will be monitored. Allow deliveries on the main branch to continue.

It is now time to change the release number on the master branch to the next release number, to avoid confusion with the release branch.

To change release number, edit $TRAF_HOME/sqenvcom.sh and modify the environment variables TRAFODION_VER_MAJOR or TRAFODION_VER_MINOR to the next version in the main master branch.

From this time on, until the release is finished, use the release branch to update the project web site. Changes to the documentation and web site made on the master branch won't be visible during this time. The "Documentation" page will still show the new release as "in development".

Create Release Notes

Find someone to pull together release notes to summarize content of the release. A starting point is the automated JIRA release notes. Go the project overview, select the release, and use the "Release Notes" button to get a link to the list.

For the RC votes, a link to JIRA is okay, but meanwhile, the markdown page to be posted on the website(http://trafodion.apache.org/release-notes.html) should be prepared and be posted to the site by the time the release announcement is due.

Updates to the release download page also need to be prepared. http://trafodion.apache.org/download.html

Guidelines are available: http://www.apache.org/dev/release-download-pages

Create a Release Candidate

Verify that all required changes have been delivered.

Create Artifacts

Trafodion uses git as its repository. When a new version is created, mark the repository with the tag to make sure it source tar can be recreated.

Clone Trafodion Repository to a fresh workspace


# Move to the directory where you want to install the Trafodion source code.
cd mysource

# Clone the Trafodion source code
git clone git://git.apache.org/trafodion.git


Ensure that you have a remote pointing to the Apache repository. USERNAME is your apache username. 


git remote add apache https://USERNAME@git-wip-us.apache.org/repos/asf/trafodion.git
git fetch apache


Create Tag

git tag -a x.x.xrc1 apache/<releaseX.X>
git show x.x.xrc1
git push apache tag x.x.xrc1
git checkout x.x.xrc1
cd core/sqf
source sqenvr.sh
cd ../..
make package-src
git describe --long --tags --dirty --always 
Save the output of the string from the above command for later

Once completed, a new source tar file exist in the distribution directory. 

Binary Artifacts

The convenience binary artifacts should be built from the source tar file, not from a git workspace. Best to create the build in a nice clean environment per the build instructions.

Note : Ensure the windows driver executables are built and uploaded as described in the section ""Make/update windows drivers" in Build Source. This way the "make package" step below will package those in. 

However, when creating these official binaries, we do want some version information built into the binaries.In the git workspace checked out to the tag, run this describe command:

The output should be a one-line string. Set the "PV_BUILDID" environment variable to that value and "PV_BRANCH" to the release branch name.

tar xvf apache-trafodion-x.x.x-src.tar.gz
cd apache-trafodion-x.x.x
cd core/sqf ; source sqenvr.sh ; cd ../..
export PV_BUILDID=x.x.xrc2-0-g12345ab
export PV_BRANCH=releaseX.X
make package-all
sqvers   # check version info

Create Artifact Checksums and Signatures

Assumption

You’ve already created the signing key and registered it at the https://pgp.mit.edu/ repository.

gpg --armor --output apache-trafodion-x.x.x-src.tar.gz.asc --detach-sig apache-trafodion-x.x.x-src.tar.gz
gpg --verify apache-trafodion-x.x.x-src.tar.gz.asc
sha512sum apache-trafodion-x.x.x-src.tar.gz > apache-trafodion-x.x.x-src.tar.gz.sha512

For the current release each of the tarfiles in the distribution directory, including the tarfile under the directories RH*, create checksums and signature files using same methods as above. Do not include the tar files for *-tests.tgz and *-regress.tgz as part of the distributed files.The list of files we need to distribute include :

$TRAF_HOME/distribution:
apache-trafodion_clients-x.x.x-RH6-x86_64.tar.gz
apache-trafodion_pyinstaller-x.x.x.tar.gz
apache-trafodion_server-x.x.x-RH6-x86_64.tar.gz
traf_ambari-x.x.x-1.noarch.rpm


$TRAF_HOME/distribution/RH6 :
apache-trafodion_server-x.x.x-1.x86_64.rpm


Test Artifacts

Build and Test Source tar File

 

Build and test the source tar file using the Build Source instructions. You should perform this test on the following environments:

 

  • Test build on a fresh VM.

  • Test build using the src tar file created above

Compare Tagged Version with Source tar File

Compare the code from the source tar file with the tagged version to make sure they match.

mkdir artifacts
mv trafodion/distribution/* artifacts/   # save artifacts
cd trafodion ; git clean -xdf            # clean any built files
git checkout x.x.xrc1                    # be sure we are on tagged version
cd ..
tar zxf artifacts/apache-trafodion-x.x.x-src.tar.gz
diff -r trafodion apache-trafodion-x.x.x

Compare the two versions; for example, by using diff, or a GUI tool such as BCompare and the "Folder Compare Report" feature.


The source package may have a generated LICENSE file and exclude git folders, etc per the .gitattributes file.

Verify Apache Requirements

Verify checksums and signatures using the Verify Signature instructions below. Ensure that the high-level directory contains valid version of:

  • LICENSE
  • NOTICE
  • RAT_README
  • README

Stage Artifacts

Once all the artifacts have been created and tested, then it’s time to stage them. Upload the artifacts to the https://dist.apache.org/repos/dist/dev/trafodion directory.

  1. Make sure svn exists. (It can be downloaded using yum.)

    which svn
svn --version # (version 1.6.11 works)

      

  2. cd to a location where you would like to checkout the trafodion source (a directory named trafodion should not exist)

  3. Checkout source code. This creates a directory called trafodion.

    svn co https://dist.apache.org/repos/dist/dev/trafodion

      

  4. cd trafodion
  5. Create a new directory for the release: svn mkdir trafodion-x.x.x-RCx
  6. Copy the artifact files to the new directory.
  7. cd to the new directory,
  8. Add the new files: svn add <filename>
  9. Verify the files.  You should have a list like this:

    svn add *
    A (bin) apache-trafodion-2.3.0-src.tar.gz
    A apache-trafodion-2.3.0-src.tar.gz.asc
    A apache-trafodion-2.3.0-src.tar.gz.sha512
    A (bin) apache-trafodion_clients-2.3.0-RH6-x86_64.tar.gz
    A apache-trafodion_clients-2.3.0-RH6-x86_64.tar.gz.asc
    A apache-trafodion_clients-2.3.0-RH6-x86_64.tar.gz.sha512
    A (bin) apache-trafodion_pyinstaller-2.3.0.tar.gz
    A apache-trafodion_pyinstaller-2.3.0.tar.gz.asc
    A apache-trafodion_pyinstaller-2.3.0.tar.gz.sha512
    A (bin) apache-trafodion_server-2.3.0-RH6-x86_64.tar.gz
    A apache-trafodion_server-2.3.0-RH6-x86_64.tar.gz.asc
    A apache-trafodion_server-2.3.0-RH6-x86_64.tar.gz.sha512
    A RH6
    A RH6/apache-trafodion_server-2.3.0-1.x86_64.rpm.asc
    A (bin) RH6/apache-trafodion_server-2.3.0-1.x86_64.rpm
    A RH6/apache-trafodion_server-2.3.0-1.x86_64.rpm.sha512
    A (bin) traf_ambari-2.3.0-1.noarch.rpm
    A traf_ambari-2.3.0-1.noarch.rpm.asc
    A traf_ambari-2.3.0-1.noarch.rpm.sha512

  10. Commit your changes.

    svn status
svn commit -m "message..."

    Go to https://dist.apache.org/repos/dist/dev to see if your changes were committed.

  11. (Future Release) Also stage JDBC jar file in maven repo. http://www.apache.org/dev/publishing-maven-artifacts.html

Verification

See: https://www.apache.org/info/verification

All artifacts have been uploaded to the staging area.

Verify Signature

Download all the artifacts from the staging area including: 

apache-trafodion-x.x.x-src.tar.gz
apache-trafodion-x.x.x-src.tar.gz.asc
apache-trafodion-x.x.x-src.tar.gz.sha512
Check signatures and checksums.

Verify Apache Requirements

Next, run rat to make sure all files have Apache copyrights. See the file RAT_README in the top level source directory for steps to download the Rat jar file and running the tool , redirecting to an output file to look at all the details. 

java -jar /path/to/apacherat.jar -E .rat-excludes -d $(pwd)



Complete Release

Ask for a vote from the Apache Trafodion community

 Send an email to dev@trafodion.apache.org asking for a vote from the Apache Trafodion community.

  • Subject: [VOTE] Apache Trafodion release x.x.x ready for release - release candidate x
  • Message contents (see example of how other Apache projects create their contents)
    • request to vote
    • thanks to all contributors
    • link to the artifacts
    • link to git repository and its tag
    • link to verify, build, and test instructions 
    • link to release notes
    • key of person who signed the release
    • if not the first release candidate, then any changes from previous vote on the same release

The vote will be open for 72 hours (at least).  If any -1 votes returned, resolve the issue which may require the current vote to be cancelled and propose a new release candidate.  At least three +1 binding votes are needed to take this to the next phase.

If problems arise which requires a new vote, resend the original VOTE email to mailto:dev@trafodion.apache.org , prepend [CANCEL] to the title and add a short explanation why the vote was cancelled.

  • Subject: [CANCEL][VOTE] Apache Trafodion release x.x.x ready for release - release candidate x

If the vote is successful (no -1's and at least three +1's) after 72 hours, report the results of the vote:

  • Subject: [RESULT][VOTE] Apache Trafodion release x.x.x ready for release - release candidate x

Final Release

Git Label

Upload Release Artifacts

Update Project Web Site

Add the Release Notes to the web site and update the downloads page.

Files to be updated are docs/src/site/markdown. They can be previewed by generating the HTML files (mvn site) and viewing them in browser.

Submit a pull request for these changes to the master branch. Both download.md and documentation.md need new sections for the latest release. Note that this will be the first time that manuals for the next release (main branch) will be published on the site. Those documents will now appear in the "Latest (In Development)" section.

Update Apache Database

This step can be done only by a project PMC. If release manager is not an Trafodion PMC then please reach out to an existing Trafodion PMC or contact Trafodion PMC chair to complete this step.

Performing this step keeps https://reporter.apache.org/?trafodion site updated and people using the Apache Reporter Service will be able to see the latest release data for Trafodion.

Wait for Mirrors to Synch

Wait 24 hour for the artifacts to be distributed to the mirrors. Go to www.apache.org/dyn/closer.lua, click on one or more of the mirror locations, click on Trafodion.  Under Trafodion, you should see the release artifacts. Once the links work, commit the pull request for the web site and publish the site.

Announce the Release

A message should be sent to the user@trafodion.apache.org, dev@trafodion.apache.org,  and the announce@apache.org lists.

Title: [ANNOUNCE] Release Apache Trafodion x.x.x

Contents should include release summary and/or link to release notes as well as link to download site. The contents should avoid mentioning any specific company name, even the change was done by a specific company.