Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fix details and specialize emails for minifi c++

...

  • Are the LICENSE and NOTICE files present in the source root and complete?
    • Specifically look in the nifi-${MINIFI_VERSION}-sources-release.zip artifact and ensure these files are present at the root of the archive.
  • Evaluate the sources and dependencies.
    • Does the overall LICENSE and NOTICE appear correct?
    • Do all licenses fit within the ASF approved licenses?
  • Is there a README available that explains how to build the application and to execute it?
    • Look in the *-sources.zip artifact root for the readme.
  • Are the signatures and hashes correct for the source release?
    • Validate the hashes of the sources artifact do in fact match
    • Validate the signature of the source artifact.
    • Need a quick reminder on how to verify a signature?
  • Do all sources have necessary headers?
    • Unzip the sources file into a directory and execute mvn install -Pcontrib-check
  • Are there no unexpected binary files in the release?
    • The only thing we'd expect would be potentially test resources files.
  • Does the app (if appropriate) execute and function as expected?

...

  1. Create a JIRA ticket for the release tasks for version ${MINIFI_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.  Versions can be managed at https://issues.apache.org/jira/projects/MINIFICPP?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page
  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.
    1. May be useful to add links to processor documentation so it is easier to diff releases. 
  4. Create a new branch off 'master' named after the JIRA ticket.
    $ git checkout -b MINIFICPP- ${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:
    TODO/DISCUSS:  Since we don't have a dependency management framework we will include only base extensions.
    mkdir build && cd build && cmake -DPORTABLE=ON .. && make package && make package_source && make test && make linter && make docker
    * If building on Ubuntu 16.X environments add -DBUILD_ROCKSDB=true flag to cmake

  7. Startup and test the application with from the build folder:
    tar xf xvzf nifi-minifi-cpp-${MINIFI_VERSION}-bin.tar.gz && ./nifi-minifi-cpp-${MINIFI_VERSION}/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-CPP- ${JIRA_TICKET}-RC${RC}

Generate convenience binaries

...

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

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

    1. TO: dev@nifi.apache.org
    2. FROM: ${RM_USERID}@apache.org
    3. SUBJECT:  Apache NiFi MiNiFi C++ ${
    NIFI
    1. MINIFI_VERSION} RC${RC} Release Helper Guide

      Hello Apache NiFi community,

      Please find the associated guidance to help those interested in validating/verifying the release so they can vote.

      # Download latest KEYS file:
      https://dist.apache.org/repos/dist/dev/nifi/KEYS

      # Import keys file:
      gpg --import KEYS

    # [optional] Clear out local maven artifact repository


    1. # Pull down nifi-minifi-cpp-${
    NIFI
    1. MINIFI_VERSION} source release artifacts for review:

      wget https://dist.apache.org/repos/dist/
    release
    1. dev/nifi/nifi-minifi-cpp/${MINIFI_VERSION}/nifi-minifi-cpp-${MINIFI_VERSION}
    /nifi-minifi-cpp-${MINIFI_VERSION}-source-release.zip
    1. -source.tar.gz
      wget https://dist.apache.org/repos/dist/
    release
    1. dev/nifi/nifi-minifi-cpp
    /${MINIFI_VERSION}
    1. /
    nifi-minifi-cpp-
    1. ${MINIFI_VERSION}/nifi-minifi-cpp-${MINIFI_VERSION}-source
    -release
    1. .zip.asc
      wget https://dist.apache.org/repos/dist/
    release
    1. dev/nifi/nifi-minifi-cpp
    /${MINIFI_VERSION}
    1. /
    nifi-minifi-cpp-
    1. ${MINIFI_VERSION}/nifi-minifi-cpp-${MINIFI_VERSION}-source
    -release
    1. .zip.sha1
      wget https://dist.apache.org/repos/dist/
    release
    1. dev/nifi/nifi-minifi-cpp
    /${MINIFI_VERSION}
    1. /
    nifi-minifi-cpp-
    1. ${MINIFI_VERSION}/nifi-minifi-cpp-${MINIFI_VERSION}-source
    -release
    1. .zip.sha256

      # Verify the signature
      gpg --verify nifi-minifi-cpp-${MINIFI_VERSION}-source
    -release
    1. .
    zip
    1. tar.gz.asc

      # Verify the hashes (sha1, sha256) match the source and what was provided in the vote email thread
      sha1sum nifi-minifi-cpp-${MINIFI_VERSION}-source
    -release
    1. .tar.
    zip
    1. gz
      sha256sum nifi-minifi-cpp-${MINIFI_VERSION}-source
    -release
    1. .tar.
    zip
    1. gz

      #
    Unzip
    1. Extract nifi-minifi-
    cpp$
    1. cpp-${MINIFI_VERSION}-source
    -release.zip
    # Verify the build works including release audit tool (RAT) checks
    1. .tar.gz

      # Verify the build works including tests and linter checks
      cd nifi-minifi-cpp-${MINIFI_VERSION}
      mkdir build && cd build && cmake .. && make package && make test && make linter

      # On Windows:
      # Install dependencies as documented: https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139627733
      # cd nifi-minifi-cpp-${MINIFI_VERSION}
    mkdir build && cd build && cmake .. && make package make test && make linter
    1. # win_build_vs.bat build /P

      # 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 
    1. in build/nifi-minifi-cpp-${MINIFI_VERSION}-bin.tar.gz

      # 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!
  3. Developers in the community review the release candiate and reply to the vote email with their vote.

  4. After 72 hours if

    • at least 3 binding (PMC members) cast +1 votes, and
    • the positive binding votes out number any negative binding votes
  5. 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.
  6. RM sends vote result email.

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

      Apache NiFi Community,

      I am pleased to announce that the ${NIFIMINIFI_VERSION} release of Apache NiFi MiNiFi C++ 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}

...

minifi-sample-config.tgz.gpg