Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: improve copypastability of git commands involving ${JIRA_TICKET}

...

  • 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.
    ${MINIFI_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}       MINIFIMINIFICPP-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.

...

  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

  7. Startup and test the application with from the build folder:
    tar 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. Move convenience binaries and related artifacts from dist/dev to dist/release:
    $ svn move - MINIFI-m "${JIRA_TICKET} "   https://dist.apache.org/repos/dist/dev/nifi/nifi-minifi-cpp/ ${MINIFI_VERSION} https://dist.apache.org/repos/dist/release/nifi/nifi-minifi-cpp/ ${MINIFI_VERSION}

...