Versions Compared

Old Version 2

changes.mady.by.user Aldrin Piri

Saved on

compared with

New Version 3

changes.mady.by.user Aldrin Piri

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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-${NIFIMINIFI_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.
    ${NIFIMINIFI_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.

...

...

  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 NIFIMINIFICPP-${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. 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.

  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 ${NIFI_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}

...

  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/${NIFIMINIFI_VERSION} https://dist.apache.org/repos/dist/release/nifi/nifi-minifi-cpp/${NIFIMINIFI_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

  3. Create a proper signed tag of the released codebase based on the RC Tag craeted during the Maven release process.

    $ git tag -s rel/nifi-${NIFIMINIFI_VERSION} -m "${JIRA_TICKET} signed release tag for approved release of NiFi MiNiFi C++ ${NIFIMINIFI_VERSION}" ${RC_TAG_COMMIT_ID}
    For instructions on setting up to sign your tag see here.

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

    $ git push asf rel/nifi-${NIFIMINIFI_VERSION} rel/nifi-${NIFIMINIFI_VERSION}
  5. Update the release notes with the final date of the release.

  6. After the release has been complete for 24 hours send the release announcement.

...