Versions Compared

Old Version 1

changes.mady.by.user Aldrin Piri

Saved on

compared with

New Version 2

changes.mady.by.user Aldrin Piri

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note:  This document is a work in progress and heavily derived from the NiFi Release guide generated by the community.  The idea is that with processes fully established for each project we can consolidate at a later point.

Apache MiNiFi Release Guidelines

The purpose of this document is to capture and describe the steps involved in producing an official release of Apache NiFi MiNiFI for both Java and C++ versions. It is written specifically to someone acting in the capacity of a Release Manager (RM).

Table of Contents

The objective

Our aim is to produce an official Apache NiFi MiNiFi C++ release from an existing release branch.

Background Material

Terms

  • Release Manager (RM) - the Apache NiFi PMC Member or Committer acting as Release Manager for a particular release of Apache NiFi MiNiFi C++.
  • Release Candidate (RC) - an iteration of the release process that is proposed for a vote by the Apache NiFi Community.
  • Community - the community of people with an interest in the improvement and advancement of Apache NiFi, and its associated projects, including end-users, developers, evangelists, and advisers.
  • PMC - within the Apache NiFi community, members of the PMC oversee the ongoing project.
  • Committer - with the Apache NiFi community, committers have gain the privilege to commit changes to the Apache NiFi codebase.

High level flow of a release

  • The Apache NiFi community is constantly contributing to JIRA tickets assigned to the next release.
  • At some point the number of tickets open/remaining for the next release begins to approach zero.
  • A member of the community suggests a release and initiates a discussion.
  • Someone volunteers to perform the Release Manager (RM) role for the release. (This can be a committer but Apache guides indicate a preference for a PMC member.)
  • The RM validate the proposed release and stages the source code, Maven artifacts, and distributable files for a Release Candidate (RC).
  • The RM initiates a vote on the RC by the NiFi community.
  • If the NiFi community rejects the RC, the issues noted are resolved and another RC is generated.
  • If the NiFi community accepts the RC, the staged source code, artifacts, and distribution files are moved to the appropriately locations for public release.

Variable reference substitutions

Throughout this guide, references must be made to names and values that will vary from release to release. For clarity those variable values have been written like Bash variable references. When a term like "/tmp/src/nifi-${NIFI_VERSION}" is seen in an instruction or email template it should be replaced with "/tmp/src/nifi-0.7.0" when working the release of "Apache NiFi 0.7.0".
  • Subtitutions used in tasks and email templates

    Reference            Example value       Description
    =========            ==============      ===========
    ${BRANCH}            0.7.0-SNAPSHOT      the development branch on which the release is based.
    ${NIFI_VERSION}      0.7.0               the version currently in development on the release branch.
    ${NEXT_VERSION}      0.7.1-SNAPSHOT      the future version for development on the release branch.
    ${JIRA_TICKET}       MINIFI-2112           the JIRA ticket created by the release manager for the release tasks.
    ${RC}                2                   the Release Candidate index start at 1 for the first release candidate.
    ${RC_TAG_COMMIT_ID}                      the commit ID of the RC tag created during the Maven release process.
    ${RM_USERID}         johndoe             the Apache account ID of Release Manager.
    ${RELEASE_TAG}       rel/minifi-0.7.0      the Git repository tag for the source code as released.
    ${VOTE_THREAD_URL}   [0.7.0 vote thread][070-rc2-vote]   the URL for the Apache Pony Mail archive of the release vote thread.

    To be practical but avoid confusion with future release details, these example values reflect the previous release NiFi 0.7.0 RC2 release details.

What to validate and how to validate a release

The following is a list of the sorts of things that will be validated and are the basics to check when evaluating a release for a vote.
This list is reflected in the Release Vote and Release Helper Guide emails that are sent once the release has been staged in the Git and Nexus repositories.

The Release Process

The release process includes steps to be performed by the Release Manager as well as the Apache NiFi developer community.

Step 1. Configure the build environment (RM and community)

  1. Follow the steps outlined in the https://github.com/apache/nifi-minifi-cpp#getting-started to prepare the development system.
  2. Confirm that the local Git workspace is configured with an origin remote pointing to the RM's personal fork of the NiFi source and an "ASF" remote pointing to the Apache Git Repository for NiFi.
    $ git remote -v
    asf    https://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp.git (fetch)
    asf    https://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp.git (push)
    origin    https://github.com/${RM_USERID}/nifi-minifi-cpp.git (fetch)
    origin    https://github.com/${RM_USERID}/nifi-minifi-cpp.git (push)
    Additional remotes will not cause a problem if these two are correct. Other configurations are perfectly acceptable but the appropriate adjustments to the steps in this guide must be made by the release manager.
  3. Confirm that source code can be checked out for the branch being released.
    git checkout ${BRANCH}
  4. Confirm that the entire application builds correctly in the build environment.

Step 2. Prepare and stage the release (RM)

  1. Create a JIRA ticket for the release tasks for version ${NIFI
    VERSION}.

    _The resulting JIRA ticket number is referred to as ${JIRA_TICKET} in this guide.
  2. Create the next version in JIRA, if it doesn't already exist, so work can continue towards that release.
  3. Create meaningful release notes for this version if not already created. Enter them here https://cwiki.apache.org/confluence/display/MINIFI/Release+Notes#ReleaseNotes-MiNiFi(C++) on the MiNiFi wiki.
  4. Create a new branch off 'master' named after the JIRA ticket.
    $ git checkout -b NIFI-${JIRA_TICKET}-RC${RC} ${BRANCH}
  5. Verify that you have the needed dependencies to build and run MiNiFi
  6. Ensure the the full application builds, all tests work, and source passes linting by executing the following:

    mkdir build && cd build && cmake .. && make package && make package_source && make test && make linter

  7. Startup and test the application with from the build folder:
    tar xf nifi-minifi-cpp-0.2.0-bin.tar.gz && ./nifi-minifi-cpp-0.2.0/bin/minifi.sh start

  8. Evaluate and ensure the appropriate license headers are present on all source files.

  9. Ensure LICENSE and NOTICE files are complete and accurate. (Developers should always be keeping these up to date as they go along adding source and modifying dependencies to keep this burden manageable.)
  1. The validated artifacts all look good then push the branch to origin release branch to the ASF repository.

    $ git push asf MINIFI-${JIRA_TICKET}-RC${RC}
Generate convenience binaries
    OS X
    Linux - RHEL based
    Linux - Debian based
  • Create the signature and hashes for the source release and convenience binary files.
for artifact in $(find . -type f -name '*.tar.gz'); 
do
    echo $artifact;
    echo “Generating ASCII armored GPG signature”;
    gpg -a -b --digest-algo=SHA512 ${artifact};
    echo “Generating md5sum hash”;
    md5sum ${artifact} | cut -d" " -f1 > ${artifact}.md5
    echo “Generating sha1sum hash”;
    gsha1sum ${artifact} | cut -d" " -f1 > ${artifact}.sha1
    echo “Generating sha25sum hash”;
    gsha256sum ${artifact} | cut -d" " -f1 > ${artifact}.sha256
  done
    1. ASCII armored GPG signatures (--digest-algo=SHA512 select the SHA512 hash algorithm). Configure GPG to always prefer stronger hashes.
      $ gpg -a -b --digest-algo=SHA512 nifi-${NIFI_VERSION}-source-release.zip  # produces nifi-${NIFI_VERSION}-source-release.zip.asc
      $ gpg -a -b --digest-algo=SHA512 nifi-${NIFI_VERSION}-bin.tar.gz          # produces nifi-${NIFI_VERSION}-bin.tar.gz.asc
      $ gpg -a -b --digest-algo=SHA512 nifi-${NIFI_VERSION}-bin.zip             # produces nifi-${NIFI_VERSION}-bin.zip.asc
    2. Generate md5 hash summaries.
      $ md5sum nifi-${NIFI_VERSION}-source-release.zip | cut -d" " -f1 > nifi-${NIFI_VERSION}-source-release.zip.md5
      $ md5sum nifi-${NIFI_VERSION}-bin.tar.gz | cut -d" " -f1 > nifi-${NIFI_VERSION}-bin.tar.gz.md5
      $ md5sum nifi-${NIFI_VERSION}-bin.zip | cut -d" " -f1 > nifi-${NIFI_VERSION}-bin.zip.md5
    3. Generate SHA1 hash summaries.
      $ sha1sum nifi-${NIFI_VERSION}-source-release.zip | cut -d" " -f1 >  nifi-${RELEASAE}-source-release.zip.sha1
      $ sha1sum nifi-${NIFI_VERSION}-bin.tar.gz | cut -d" " -f1 >  nifi-${RELEASAE}-bin.tar.gz.sha1
      $ sha1sum nifi-${NIFI_VERSION}-bin.zip | cut -d" " -f1 >  nifi-${RELEASAE}-bin.zip.sha1
    4. Generate SHA256 hash summaries.
      $ shasum -a 256 nifi-${NIFI_VERSION}-source-release.zip | cut -d" " -f1 >  nifi-${NIFI_VERSION}-source-release.zip.sha256
      $ shasum -a 256 nifi-${NIFI_VERSION}-bin.tar.gz | cut -d" " -f1 >  nifi-${NIFI_VERSION}-bin.tar.gz.sha256
      $ shasum -a 256 nifi-${NIFI_VERSION}-bin.zip | cut -d" " -f1 >  nifi-${NIFI_VERSION}-bin.zip.sha256
  2. For reviewing of the release candidate, commit the source release and convenience binaries files along with their hashes and signatures to https://dist.apache.org/repos/dist/dev/nifi/nifi-minifi-cpp/${VERSION}

Step 4. Error recovery (RM)

If anything isn't correct about the staged artifacts you can drop the staged repo from repository.apache.org and delete the local tag in git. If you also delete the local branch and clear your local maven repository under org/apache/nifi then it is as if the release never happened. Before doing that though try to figure out what went wrong so the Release Guide can be updated or corrected if necessary.
So, as has been described here you can test the release process until you get it right. The mvn versions:set and mvn versions:commit commands can come in handy to help do this so you can set versions to something clearly release test related.

Step 5. Release Vote (RM and community)

After the release source and artifacts are staged in the repositories it's time for the RM to send a release vote to the NiFi community.
Once the release vote is called for, members of the NiFi developer community have 72 hours to evaluate the RC and cast their vote by replying to the "[VOTE] Release ..." email sent by the RM.
NOTE: The release vote is majority rule vote that must include at least 3 binding +1 votes Apache NiFi PMC members and more positive than negative binding votes.

Apache MiNiFi Release Guidelines

The purpose of this document is to capture and describe the steps involved in producing an official release of Apache NiFi MiNiFI for both Java and C++ versions. It is written specifically to someone acting in the capacity of a Release Manager (RM).

Table of Contents

Background Material

The objective

Our aim is to produce an official Apache release.
The following is a list of the sorts of things that will be validated and are the basics to check when evaluating a release for a vote.

What to validate and how to Validate a release

The flow of a release (an outline)

  • The community is contributing to a series of JIRA tickets assigned to the next release
  • The number of tickets open/remaining for that next release approaches zero
  • A member of the community suggests a release and initiates a discussion
  • Someone volunteers to be an RM for the release (can be a committer but apache guides indicate preference is a PMC member)
  • A release candidate is put together and a vote sent to the team.
  • If the NiFi community rejects the vote the issues noted are resolved and another RC is generated
  • If the NiFi community accepts the vote then the release is 'releasable' and can be placed into the appropriate 'dist' location, maven artifacts released from staging.

The mechanics of the release

Prepare your environment

Follow the steps outlined in the Quickstart Guide

At this point you're on the latest 'master' branch and are able to build the entire application

...

Create the next version in JIRA if necessary so work can continue towards that release.

Create meaningful release notes for this version if not already created. Enter them here

Create new branch off 'master' named after the JIRA ticket. Here we'll use a branch off of 'master' with git checkout -b NIFI-270-RC1

Verify that Maven has sufficient heap space to perform the build tasks. Some plugins and parts of the build consumes a surprisingly large amount of space. These settings have been shown to work MAVEN_OPTS="-Xms1024m -Xmx3076m -XX:MaxPermSize=256m"

Ensure your settings.xml has been updated as shown below. There are other ways to ensure your PGP key is available for signing as well

        ...
        <profile>
           <id>signed_release</id>
           <properties>
               <mavenExecutorId>forked-path</mavenExecutorId>
               <gpg.keyname>YOUR GPG KEY ID HERE</gpg.keyname>
               <gpg.passphrase>YOUR GPG PASSPHRASE HERE</gpg.passphrase>
           </properties>
       </profile>
       ...
       <servers>
          <server>
              <id>repository.apache.org</id>
              <username>YOUR USER NAME HERE</username>
              <password>YOUR MAVEN ENCRYPTED PASSWORD HERE</password>
          </server>
       </servers>
       ...

Ensure the the full application build and tests all work by executing mvn -T 2.5C clean install for a parallel build. Once that completes you can startup and test the application by cd nifi-assembly/target then run bin/nifi.sh start in the nifi build. The application should be up and running in a few seconds at http://localhost:8080/nifi

Evaluate and ensure the appropriate license headers are present on all source files. Ensure LICENSE and NOTICE files are complete and accurate.
Developers should always be keeping these up to date as they go along adding source and modifying dependencies to keep this burden manageable.
This command mvn install -Pcontrib-check should be run as well to help validate. If that doesn't complete cleanly it must be addressed.

Now its time to have maven prepare the release so execute mvn release:prepare -Psigned_release -DscmCommentPrefix="NIFI-270-RC1 " -Darguments="-DskipTests". Maven will ask:

What is the release version for "Apache NiFi"? (org.apache.nifi:nifi) 0.0.1: :

Just hit enter to accept the default.

Maven will then ask:

What is SCM release tag or label for "Apache NiFi"? (org.apache.nifi:nifi) nifi-0.0.1: :

Enter nifi-0.0.1-RC1 or whatever the appropriate release candidate (RC) number is. Maven will then ask:

What is the new development version for "Apache NiFi"? (org.apache.nifi:nifi) 0.0.2-SNAPSHOT: :

Just hit enter to accept the default.

Now that preparation went perfectly it is time to perform the release and deploy artifacts to staging. To do that execute

mvn release:perform -Psigned_release -DscmCommentPrefix="NIFI-270-RC1 " -Darguments="-DskipTests"

That will complete successfully and this means the artifacts have been released to the Apache Nexus staging repository. You will see something like

[INFO] * Closing staging repository with ID "orgapachenifi-1011".

So if you browse to https://repository.apache.org/#stagingRepositories login with your Apache committer credentials and you should see orgapachenifi-1011. If you click on that you can inspect the various staged artifacts.

Validate that all the various aspects of the staged artifacts appear correct

  • Download the sources. Do they compile cleanly? If the result is a build does it execute?
  • Validate the hashes match.
  • Validate that the sources contain no unexpected binaries.
  • Validate the signature for the build and hashes.
  • Validate the LICENSE/NOTICE/Headers.
  • Validate that the README is present and provides sufficient information to build and if necessary execute.

If all looks good then push the branch to origin git push origin NIFI-270

For reviewing of the release candidate - The sources, hashes, signature, and the convenience binary, its hashes, and signature should be placed here:

- https://dist.apache.org/repos/dist/dev/nifi-0.0.1/

...

- Generate ascii armored detached signature by running `gpg -a -b --digest-algo=SHA512 nifi-0.0.1-bin.tar.gz`
- Generate md5 hash summary by running `md5sum nifi-0.0.1-bin.tar.gz | awk '{ printf substr($0,0,32)}' >  nifi-0.0.1-bin.tar.gz.md5`
- Generate sha1 hash summary by running `sha1sum nifi-0.0.1-bin.tar.gz | awk '{ printf substr($0,0,40)}' >  nifi-0.0.1-bin.tar.gz.sha1`
- Upload the bin, asc, sha1, md5 for each binary convenience build to the same location as the source release

...

Now it's time to initiate a vote within the NiFi community. Send the vote request to dev@nifi.apache.org with a subject of [VOTE] Release Apache NiFi 0.0.1. The following template can be used:

...

  1. RM sends a vote request email to the NiFi Developers Mailing List.

  3. RM sends the following helper email to the NiFi Developers Mailing List.

...

...

...

...

...

...

...

...

    • _VERSION}/nifi-${NIFI_VERSION}-source-release.zip.sha1
      wget https://dist.apache.org/repos/dist/dev/nifi/nifi-${NIFI_VERSION}/nifi-${NIFI_VERSION}-source-release.zip.sha256

      # Verify the signature
      gpg --verify nifi-${NIFI_VERSION}-source-release.zip.asc

      # Verify the hashes (md5, sha1, sha256) match the source and what was provided in the vote email thread
      md5sum nifi-${NIFI_VERSION}-source-release.zip
      sha1sum nifi-${NIFI_VERSION}-source-release.zip
      sha256sum nifi-${NIFI_VERSION}-source-release.zip

      # Unzip nifi-${NIFI_VERSION}-source-release.zip

      # Verify the build works including release audit tool (RAT) checks
      cd nifi-${NIFI_VERSION}
      mvn clean install -Pcontrib-check

      # Verify the contents contain a good README, NOTICE, and LICENSE.

      # Verify the git commit ID is correct

      # Verify the RC was branched off the correct git commit ID

      # Look at the resulting convenience binary as found in nifi-assembly/target

      # Make sure the README, NOTICE, and LICENSE are present and correct

      # Run the resulting convenience binary and make sure it works as expected

      # Send a response to the vote thread indicating a +1, 0, -1 based on your findings.

      Thank you for your time and effort to validate the release!
  2. Developers in the community review the release candiate and reply to the vote email with their vote.

  3. After 72 hours if

    • at least 3 binding (PMC members) cast +1 votes, and
    • the positive binding votes out number any negative binding votes
    the vote passes and the release candidate is officially released. If the vote does not pass, corrections are made on the release branch and a new release candidate is put forward for a new vote.
  5. RM sends vote result email.

    • TO: dev@nifi.apache.org
    • FROM: ${RM_USERID}@apache.org
    • SUBJECT: [RESULT][VOTE] Release Apache NiFi ${NIFI_VERSION}

      Apache NiFi Community,

      I am pleased to announce that the ${NIFI_VERSION} release of Apache NiFi passes with
        X +1 (binding) votes
        Y -1 (binding) votes
        0 0 votes
        0 -1 votes

      Thanks to all who helped make this release possible.

      Here is the PMC vote thread: ${VOTE_THREAD_URL}

Step 6. Finalize the Release

After the vote is complete and the release is approved, these steps complete the release process.
  1. Move convenience binaries and related artifacts from dist/dev to dist/release:
    $ svn move -m “MINIFI-${JIRA_TICKET}” https://dist.apache.org/repos/dist/dev/nifi/nifi-minifi-cpp/${NIFI_VERSION} https://dist.apache.org/repos/dist/release/nifi/nifi-minifi-cpp/${NIFI_VERSION}
  1. Update the MiNiFi website to point to the new download(s). Remove older release artifacts from download page (leave the current release and the previous one). For the release just previous to this new one change the links to point to the archive location. See current page as an example of the needed URL changes. In addition to updating the download page as described delete artifacts other than the current/new release from the dist/nifi SVN storage. They are already in the archive location so no need to do anything else.

  2. Update the NiFi Web Page to indicate NEWS of the release as appropriate

...

Hello

The release passes with

X +1 (binding) votes
Y -1 (binding) votes

Thanks to all who helped make this release possible.

Here is the PMC vote thread: [INSERT URL OF PMC Vote Thread]

...

Here are the steps of the release once the release is approved:

  1. Move convenience binaries and related artifacts from dist/dev to dist/release:
    svn move -m "NIFI-1122" https://dist.apache.org/repos/dist/dev/nifi/nifi-0.0.1 https://dist.apache.org/repos/dist/release/nifi/0.0.1 

  2. In repository.apache.org go to the staging repository and select release and follow instructions on the site.

  3. Merge the release branch into master

  4. Update the NiFi website to point to the new download(s). Remove older release artifacts from download page (leave the current release and the previous one). For the release just previous to this new one change the links to point to the archive location. See current page as an example of the needed URL changes. In addition to updating the download page as described delete artifacts other than the current/new release from the dist/nifi SVN storage. They are already in the archive location so no need to do anything else.

  5. Update the Migration Guide on the Wiki.

  6. Update the NiFi Web Page to indicate NEWS of the release as appropriate

  7. From a nifi.tar.gz collect the docs/html/* files and svn commit them to https://svn.apache.org/repos/asf/nifi/site/trunk/docs/nifi-docs/html/

  8. From a nifi.tar.gz collect the nifi-framework-nar.nar/META-INF/bundled-dependencies/nifi-web-api.war/docs/rest-api/* files and svn commit them to https://svn.apache.org/repos/asf/nifi/site/trunk/docs/nifi-docs/rest-api/

  9. Run an instance of nifi

  10. Copy nifi/work/docs/components/* and svn commit to https://svn.apache.org/repos/asf/nifi/site/trunk/docs/nifi-docs/components/

  11. wget http://localhost:8080/nifi-docs/documentation and svn commit to https://svn.apache.org/repos/asf/nifi/site/trunk/docs/nifi-docs/index.html

  12. In Jira mark the release version as 'Released' and 'Archived' through 'version' management in the 'administration' console.

  13. Create a proper signed tag of the released codebase . If the approved RC tag was 'nifi-0.0.1-RC1' then create a signed release tag of 'rel/nifi-0.0.1'. based on the RC Tag craeted during the Maven release process.

    $ git tag -s rel/nifi-${NIFI_VERSION} -m "${JIRA_TICKET} signed release tag for approved release of NiFi ${NIFI_VERSION}" ${RC_TAG_COMMIT_ID}
    For instructions on setting up to sign your tag see here. To create a signed release tag enter git tag -s

  14. Push the release tag to the official ASF repository.

    $ git push asf rel/nifi-${NIFI_VERSION} rel/nifi-0.0.1 -m "NIFI-XYZ Signed release tag for approved release of nifi 0.0.1" COMMIT-ID-OF-RC-TAG${NIFI_VERSION}
  15. Update the release notes with the final date of the release.

  16. After the release has been complete for 24 hours send the Wait 24 hours then send release announcement.

    • See here for an understanding of why you need to wait 24 hours
    • The announcement should addressed as follows.Then create an announcement like the one shown below addressed to 'announce@apache.' with a reply-to of 'dev@nifi'.
    • The email has to be sent from an apache.org email address and should be by the release manager of the build.

...

    • The subject should include [ANNOUNCE] Apache NiFi x.y.z release.
    • The text should on the template included below. +

      Hello

      The Apache NiFi team would like to announce the release of Apache NiFi ${NIFI_VERSION}.

      Apache NiFi is an easy to use, powerful, and reliable system to process and distribute
      data.  Apache NiFi was made for dataflow.  It supports highly configurable directed graphs
      of data routing, transformation, and system mediation logic.

      More details on Apache NiFi can be found here:
      https://nifi.apache.org/

...



    • The

...

    • release

...

    • artifacts

...

    • can

...

    • be

...

    • downloaded

...

    • from

...

    • here:

...

...



    • Maven

...

    • artifacts

...

    • have

...

    • been

...

    • made

...

    • available

...

    • here:

...

...



    • Issues

...

    • closed/resolved

...

    • for

...

    • this

...

    • list

...

    • can

...

    • be

...

    • found

...

    • here:

...

...



    • Release

...

    • note

...

    • highlights

...

    • can

...

    • be

...

    • found

...

    • here:

...

...

Release Supporting and Helper Resources

Sample NiFi and MiNiFi Configuration to transmit data from MiNiFi to NiFi via Site to Site

...