Versions Compared

Old Version 1

changes.mady.by.user Aldrin Piri

Saved on

compared with

New Version Current

changes.mady.by.user Martin Zink

Saved on

Key

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

provided in the vote email thread

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-${MINIFI_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".

Substitutions used in tasks and email templates:
ReferenceExample valueDescription
${BRANCH}mainthe development branch on which the release is based
${MINIFI_VERSION}0.10.0the version currently in development on the release branch, to be released



${JIRA_TICKET}MINIFICPP-1234the JIRA ticket created by the release manager for the release tasks
${RC}1the 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}johndoethe Apache account ID of Release Manager
${RELEASE_TAG}rel/minificpp-0.10.0the Git repository tag for the source code as released
${VOTE_THREAD_URL}[0.10.0 vote thread][0100-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 release details of MiNiFi C++ 0.10.0 RC2.

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.
  • Are the LICENSE and NOTICE files present in the source root and complete?
    • Specifically look in the nifi-minifi-cpp-${MINIFI_VERSION}-sources.tar.gz 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 *-source.tar.gz 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?
    • Extract the sources file into a directory and execute mkdir build && cd build && cmake .. && make package && make test && make linter
  • 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?
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 ${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 -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}

Generate the convenience binary:
$ make centos
$ mv nifi-minifi-cpp-${MINIFI_VERSION}-bin-{centos,linux}.tar.gz


Create the signature and hashes for the source release and convenience binary files:


Code Block
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 sha512 sum hash "
  sha512sum  ${artifact} |  cut -d" " -f1 > ${artifact}.sha512
  echo  " Generating sha256 sum hash "
  sha256sum  ${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-minifi-cpp-${MINIFI_VERSION}-source.tar.gz    # produces nifi-minifi-cpp${MINIFI_VERSION}-source.tar.gz.asc
      $ gpg -a -b --digest-algo=SHA512 nifi-minifi-cpp-${MINIFI_VERSION}-bin.tar.gz          # produces nifi-minifi-cpp-${MINIFI_VERSION}-bin.tar.gz.asc
      $ gpg -a -b --digest-algo=SHA512 nifi-minifi-cpp-${MINIFI_VERSION}-bin.tar.gz          # produces nifi-minifi-cpp-${MINIFI_VERSION}-bin.tar.gz.asc
    2. Generate SHA256 hash summaries.
      $ shasum -a 256 nifi-${MINIFI_VERSION}-source-release.zip | cut -d" " -f1 >  nifi-${MINIFI_VERSION}-source-release.zip.sha256
      $ shasum -a 256 nifi-${MINIFI_VERSION}-bin.tar.gz | cut -d" " -f1 >  nifi-${MINIFI_VERSION}-bin.tar.gz.sha256
      $ shasum -a 256 nifi-${MINIFI_VERSION}-bin.zip | cut -d" " -f1 >  nifi-${MINIFI_VERSION}-bin.zip.sha256
    3. Generate SHA512 hash summaries.
      $ sha512sum nifi-${MINIFI_VERSION}-source-release.zip | cut -d" " -f1 >  nifi-${RELEASAE}-source-release.zip.sha512
      $ sha512sum nifi-${MINIFI_VERSION}-bin.tar.gz | cut -d" " -f1 >  nifi-${RELEASAE}-bin.tar.gz.sha512
      $ sha512sum nifi-${MINIFI_VERSION}-bin.zip | cut -d" " -f1 >  nifi-${RELEASAE}-bin.zip.sha512


For reviewing the release candidate, upload the source and the convenience binary tarballs, along with their hashes and signatures, to the ASF distribution repo using subversion:

Code Block
svn co https://dist.apache.org/repos/dist/dev/nifi/nifi-minifi-cpp
cd nifi-minifi-cpp
mkdir ${MINIFI_VERSION}
cp nifi-minifi-cpp-* ${MINIFI_VERSION}/
svn add ${MINIFI_VERSION}
svn commit

(you need to be a committer to do this, and svn will prompt you for your Apache password).

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:

...

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

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

      Hello,

      I am pleased to be calling this vote for the source release of Apache NiFi MiNiFi C++ ${MINIFI_VERSION}.

      The source tarball, some binary builds, plus signatures and digests can be found at:

...

- 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

...

  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++ ${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/release/nifi/KEYS

      # Import keys file:
      gpg --import KEYS

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

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

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

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

      # Extract nifi-minifi-cpp-${MINIFI_VERSION}-source.tar.gz
      tar xvzf       nifi-minifi-cpp-${MINIFI_VERSION}-source.tar.gz

      # Verify the build works including tests and linter checks
      cd nifi-minifi-cpp-${MINIFI_VERSION}-source
      mkdir build && cd build && cmake .. && make package && make test && make linter
      # or:
      # ./bootstrap.sh && cd build && 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}-source
      # 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 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 ${MINIFI_VERSION} release of Apache NiFi MiNiFi C++ passes with
        X +1 (binding) votes
        Y +1 (non-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: (a member of the PMC needs to run this)

    $ svn move -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}

  2. Update the MiNiFi website to point to the new download(s) by creating a pull request on https://github.com/apache/nifi-site and following the instructions in README.md.  Remove older release artifacts from download page (leave the current release and the previous one). 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.

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

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

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

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

    $ git push asf rel/minifi-cpp-${MINIFI_VERSION}

  6. Publish the convenience binaries to docker hub (TODO: extend this guide with details)

  7. Update the release notes with the final date of the release.

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

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:

Hello
I am pleased to be calling this vote for the source release of Apache NiFi
nifi-0.0.1.

The source zip, including signatures, digests, etc. can be found at:
https://repository.apache.org/content/repositories/orgapachenifi-1011

The Git tag is nifi-0.0.1-RC1
The Git commit ID is 72abf18c2e045e9ef404050e2bffc9cef67d2558
https://git-wip-us.apache.org/repos/asf?p=nifi.git;a=commit;h=72abf18c2e045e9ef404050e2bffc9cef67d2558

Checksums of nifi-0.0.1-source-release.zip:
MD5: 5a580756a17b0573efa3070c70585698
SHA1: a79ff8fd0d2f81523b675e4c69a7656160ff1214

Release artifacts are signed with the following key:
https://people.apache.org/keys/committer/joewitt.asc

KEYS file available here:
https://dist.apache.org/repos/dist/release/nifi/KEYS

8 issues were closed/resolved for this release:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12316020&version=12329307

Release note highlights can be found here:
https://cwiki.apache.org/confluence/display/NIFI/Release+Notes#ReleaseNotes-Version0.0.1

The vote will be open for 72 hours. 
Please download the release candidate and evaluate the necessary items including checking hashes, signatures, build from source, and test.  The please vote:

[ ] +1 Release this package as nifi-0.0.1
[ ] +0 no opinion
[ ] -1 Do not release this package because because...

...

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'. For instructions on setting up to sign your tag see here. To create a signed release tag enter git tag -s rel/nifi-0.0.1 -m "NIFI-XYZ Signed release tag for approved release of nifi 0.0.1" COMMIT-ID-OF-RC-TAG

  14. Wait 24 hours then send release announcement.

    • See here for an understanding of why you need to wait 24 hours
    • Then create an announcement like the one shown below addressed to 'announce@apache.org, dev@nifi..apache.org' with a reply-to of 'dev@nifi.apache.org'.
    • The email has to be sent from an apache.org email address and should be by the release manager of the build.
SUBJECT:  [ANNOUNCE] Apache NiFi 0.0.1 release
BODY:
Hello

The Apache NiFi team would like to announce the release of Apache NiFi 0.0.1.

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:
http://nifi.apache.org/

The release artifacts can be downloaded from here:
http://nifi.apache.org/download.html

Maven artifacts have been made available here:
https://repository.apache.org/content/repositories/releases/org/apache/nifi/

Issues closed/resolved for this list can be found here:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12316020&version=12329373

Release note highlights can be found here:
https://cwiki.apache.org/confluence/display/NIFI/Release+Notes#ReleaseNotes-Version0.0.1

Thank you
The Apache NiFi team

 

Release Supporting and Helper Resources

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

The following archive contains a flow.xml.gz to configure a flow with a known input port UUID to communicate with a configuration for MiNiFI C++ with the included flow.yml. 

minifi-sample-config.tgz

Hashes

  • md5sum: 871b465492eb6cb0d9072c50b08fe4b1

  • sha1sum: 5b3797924eee1a59421ff216c542cb28c3564bfe

  • sha256sum: 9323165a2086053f8d1ad5478e2b7cc97f01fbc38ba133afe77badba1a446833

Signature

Signed with the key at http://people.apache.org/keys/committer/aldrin.asc

minifi-sample-config.tgz.gpg

...