You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Next »

This document summarizes the steps of release process for Qpid Java Components

Pre-Requirements

The release process is based on Apache Release Policy,  Release Signing and Publishing of Maven Documents

PGP

Release artifacts needs to be signed. GNU Privacy Guard from OpenPGP is used to sign on Apache. Please, refer Release Signing about PGP public key cryptography. The document provides basic information about release signing and contains links to various resources about PGP public key cryptography and how to use GNU Privacy Guard to generate and sign the PGP keys. Install GNU Privacy Guard, generate keys following steps provided here and upload public keys to keyservers . After publishing keys, login into https://id.apache.org and enter PGP key fingerprint(s), then the corresponding keys will be made available under https://people.apache.org/keys/ within a few hours. Additionally, qpid project requires adding a public key into https://dist.apache.org/repos/dist/release/qpid/KEYS.

Maven

Maven is used to build and manage Qpid Java project. 3.x version of maven needs to be installed and the development environment should be setup as described at Publishing of Maven Artifacts.

Please, note that repository id (server id) in setting xml should be apache.releases.https. Using different id would result in failures to publish release artifacts into staging maven repo.

Java

JDK 1.7 is required to compile java classes. Install latest 1.7 JDK. At the moment of writing this document 1.7.0_80 JDK was the latest one.

SVN

Sources are kept in SVN repo. Thus svn client is required

Major version release

  1. Checkout Qpid sources from trunk using svn client.

    svn co https://svn.apache.org/repos/asf/qpid/java/trunk qpid-java
cd ./qpid-java

  2. Run RAT tool to verify that all source files have license headers

    mvn  apache-rat:check

  3. Check that build completes successfully using profile apache-release

    mvn clean install -Papache-release -DskipTests

    The gpg plugin will prompt for the password of PGP  signing key. If password is asked for every release artifact, then gpg2 should be configured to use. The easiest way to configure gpg2 is to add an active profile with pgp plugin settings into settings.xml.

  4.  

    Add license headers to the files which do not have licenses. Update RAT excludes if required.

  5. Verify third party licenses

    mvn -Pdependency-check prepare-package -DskipTests

    The check should finish successfully. Otherwise, dependencies with not complaint licenses should be resolved before taking next release step.

    When new dependencies are added or changed the dependency verification files needs to be updated. In order to do so, run the command above with flag -Ddependency-change-verification=true

  6. Build alpha.

    1. Making an alpha build is optional and can be skipped if required. Alpha does not requires branching. The following chain of maven commands can be used to build and deploy alpha into staging repo
      Example of building 6.0.0-alpha

      mvn versions:set -DnewVersion=6.0.0-alpha ; mvn clean install deploy -Papache-release ; mvn versions:revert

      maven versions plugin is used to change version and revert it back after build and deploy

    2. On successful completion the build is deployed into staging repository, which needs to be closed in order to be available. Log into Apache Nexus UI, select the repository under "Staging Repository" and click Close button to close staging repository to prevent publishing of any new artifact. After closing, a permanent link to the staging repository will be available.
    3. Send an email into users@qpid.apache.org about alpha availability with a link to the staging repository.
    4.  Do not forget to delete staging repo after building RC or beta build. It requires logging into Apache Nexus UI, selecting the repository and clicking "Drop" button.
  7. Check JIRA system for any unresolved JIRAs for the release and notify assigned developers to take actions on uncompleted JIRAs

  8. Cut the branch using release:branch. Please, refer maven release plugin documentation for more details. For example, the following command was used to cut 6.0.x branch

    mvn release:branch -DbranchName=6.0.x -DupdateBranchVersions=false -DupdateWorkingCopyVersions=true  -DautoVersionSubmodules=true

    As part of execution command above maven asks about new version of the trunk sources and changes the version to provided one.

  9. Build beta if required following instructions in step 5 on branched sources

  10. Build RC

    1. Checkout branch sources, for example, 6.0.x branch is checked out as below

      svn co https://svn.apache.org/repos/asf/qpid/java/branches/6.0.x
cd 6.0.x

    2. If it is not a first RC, remove previous tag sources  from svn

      svn rm https://svn.apache.org/repos/asf/qpid/java/tags/x.y.z

      where x.y.z is a tag version

    3. Cut the tag using maven:prepare

      mvn release:clean
mvn release:prepare -Papache-release,java-mms.0-9  -DautoVersionSubmodules=true -DpreparationGoals=test

      Release plugin will ask about new release version, svn tag name and new development version. Enter the same values for version and tag

      On successful execution an svn tag with a provided name will be created, the tag version will be set to the specified release version and development version on the branch will be changed to the provided one

    4. Build the RC and publish release artifacts into maven stagin repo

      mvn release:perform -Papache-release,java-mms.0-9 -Darguments="-DskipTests"

      release:perform will build release artifacts and deploy them into staging repo.

    5. The staging maven repository needs to be closed. Log into Apache Nexus UI, select the repository under "Staging Repository" and click Close button to close staging repository for any publishing of artifacts. After closing, a permanent link to the staging repository will be available.

    6. Copy source and binary bundles and their signatures/checksum files into qpid dev staging area at https://dist.apache.org/repos/dist/dev/qpid/java/ under the sub-folder with the same name as tag. Binary bundles  and their signatures/checksum files need to be put into sub-folder with name binaries. (Not doing so would break the site). Manually rename the source artefact to keep with the source artefact name consistent.

      Use curl or wget to download all broker and client tar.gz and zip bundles and their signatures from maven staging repo like so:

      version=6.0.1
root=https://repository.apache.org/content/repositories/orgapacheqpid-1066
mkdir binaries
for i in "" .asc .md5 .sha1; do curl -O  $root/org/apache/qpid/qpid-java-build/$version/qpid-java-build-$version.tar.gz$i; done
mv qpid-java-build-$version.tar.gz qpid-java-$version.tar.gz
mv qpid-java-build-$version.tar.gz.asc qpid-java-$version.tar.gz.asc 
mv qpid-java-build-$version.tar.gz.md5 qpid-java-$version.tar.gz.md5
cd binaries
for i in broker client ; do for j in zip tar.gz; do for k in "" .asc .md5 .sha1; do curl -O  $root/org/apache/qpid/qpid-$i/$version/qpid-$i-$version-bin.$j$k; done; done; done
 

    7. Send an email into users@qpid.apache.org about RC availability with links to the maven staging repository and qpid dev staging area folder containing source and binary bundles

  11. If RC is OK and voting passes, publish release artifacts:
    1. promote maven staging artifacts from staging repository into the world by pressing Release button in Apache Nexus UI.

    2. copy source and binary bundles and their signatures/checksum files form dev staging are into release distribution area. For example, the commands below copy dev 6.0.0-rc5 artifacts into final 6.0.0

      svn co --depth files https://dist.apache.org/repos/dist/release/qpid qpid-dist-release
cd ./qpid-dist-release/java
svn cp https://dist.apache.org/repos/dist/dev/qpid/java/6.0.0-rc5 .
svn mv 6.0.0-rc5 6.0.0
svn commit -m "Publish 6.0.0 release artifacts" 

      If voting does not pass, resolve found issues, drop staging repository, delete svn tag and repeat instructions from step 9 until voting passes.

  12. Update Qpid web site Qpid Java Component pages and publish new release documentation following instructions here.
    Java 8 could be required for latest fop/docbook dependencies. Here are sample commands which were used to create 6.0.0 release pages on site

    svn co https://svn.apache.org/repos/asf/qpid/site
cd ./site
make gen-java-release RELEASE=6.0.0 SOURCE_RELEASE=6.0.x ISSUES_RELEASE=qpid-java-6.0
vim ./input/releases/qpid-java-6.0.0/release-notes.md # headline major enhancements and new features
vim ./input/_transom_config.py              # Update the current release pointer
vim ./input/releases/index.md               # Add current release, move the previous
make render
make check-links
make publish
svn add input/releases/qpid-java-6.0.0
svn add docs/releases/qpid-java-6.0.0
svn commit -m "Update site for Qpid Java release 6.0.0"

     

  13. Mark release as released in JIRA and close any unresolved JIRAs if required
  14. Wait for 24 hours after closing the voting and send the release notification email into users@qpid.apache.org

Minor release procedure

Execute steps 1-6 and 8-13 from Major release procedure on branch sources.

  • No labels