Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: replace nbsp with a normal space

...

  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.  Add them to the Release Notes - MiNiFi (C++) page 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 ${BRANCH} named after the JIRA ticket.
    $ git checkout -b ${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 cmake -DENABLE_COAP=ON -DSKIP_TESTS= -DUSE_SHARED_LIBS=ON -DPORTABLE=ON -DBUILD_ROCKSDB=ON -DEXCLUDE_BOOST=ON -DBUILD_IDENTIFIER= -DCMAKE_BUILD_TYPE=Release -DFAIL_ON_WARNINGS= .. && make package_source && make package && make test && make linter && make docker

  7. Startup and test the application with from the build folder:
    $ tar xvzf nifi-minifi-cpp-${MINIFI_VERSION}.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.)

  10. If the validated artifacts all look good then create a tag and push the branch to the ASF repository.

    $ git tag -s "minifi-cpp-${MINIFI_VERSION}-RC${RC}" -m "${JIRA_TICKET} RC${RC} release candidate of NiFi MiNiFi C++ ${MINIFI_VERSION}" ${JIRA_TICKET}-RC${RC}
    $ git push --tag asf ${JIRA_TICKET}-RC${RC}

...