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).
The objective
Background Material
- These documents are necessary for all committers to be familiar with
- These documents are necessary for someone acting as the RM
- These documents are helpful for general environmental setup to perform releases
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
Reference | Example value | Description |
---|---|---|
${BRANCH} | main | the development branch on which the release is based |
${MINIFI_VERSION} | 0.10.0 | the version currently in development on the release branch |
${NEXT_VERSION} | 0.11.0 | the future version for development on the release branch |
${JIRA_TICKET} | MINIFICPP-1234 | the JIRA ticket created by the release manager for the release tasks |
${RC} | 1 | 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/minificpp-0.10.0 | the 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
- 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?
The Release Process
Step 1. Configure the build environment (RM and community)
- Follow the steps outlined in the https://github.com/apache/nifi-minifi-cpp#getting-started to prepare the development system.
- 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. - Confirm that source code can be checked out for the branch being released.
git checkout ${BRANCH} - Confirm that the entire application builds correctly in the build environment.
Step 2. Prepare and stage the release (RM)
- 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. - 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
- 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.
- May be useful to add links to processor documentation so it is easier to diff releases.
- Create a new branch off ${BRANCH} named after the JIRA ticket.
$ git checkout -b ${JIRA_TICKET} -RC ${RC} ${BRANCH} - Verify that you have the needed dependencies to build and run MiNiFi
- 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 - 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 - 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.)
- The validated artifacts all look good then push the branch to origin release branch to the ASF repository.
$ git push asf ${JIRA_TICKET}-RC${RC}
- Create the signature and hashes for the source release and convenience binary files.
- 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 - Generate SHA1 hash summaries.
$ sha1sum nifi-${MINIFI_VERSION}-source-release.zip | cut -d" " -f1 > nifi-${RELEASAE}-source-release.zip.sha1
$ sha1sum nifi-${MINIFI_VERSION}-bin.tar.gz | cut -d" " -f1 > nifi-${RELEASAE}-bin.tar.gz.sha1
$ sha1sum nifi-${MINIFI_VERSION}-bin.zip | cut -d" " -f1 > nifi-${RELEASAE}-bin.zip.sha1 - 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
- ASCII armored GPG signatures (--digest-algo=SHA512 select the SHA512 hash algorithm). Configure GPG to always prefer stronger hashes.
- For reviewing of the release candidate, commit the source release and convenience binaries files along with their hashes and signatures to https://dist.apache.org/repos/dist/dev/nifi/nifi-minifi-cpp/${VERSION}
Step 4. Error recovery (RM)
Step 5. Release Vote (RM and community)
- 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 zip, including signatures, digests, etc. can be found at:
https://dist.apache.org/repos/dist/dev/nifi/nifi-minifi-cpp/${MINIFI_VERSION}/
The Git tag is minifi-cpp-${MINIFI_VERSION}-RC${RC}
The Git commit ID is <40-BYTE-COMMIT-HASH>
https://git-wip-us.apache.org/repos/asf?p=nifi-minifi-cpp.git;a=commit;h= <40-BYTE-COMMIT-HASH>
Checksums of nifi-minifi-cpp-${MINIFI_VERSION}-source.tar.gz:
SHA256: <64-BYTE-SHA1SUM-HASH>
SHA512: <128-BYTE-SHA1SUM-HASH>
Release artifacts are signed with the following key:
https://people.apache.org/keys/committer/${RM_USERID}.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-Version${MINIFI_VERSION}
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-minifi-cpp-${MINIFI_VERSION}
[ ] +0 no opinion
[ ] -1 Do not release this package because...
- RM sends the following helper email to the NiFi Developers Mailing List.
- TO: dev@nifi.apache.org
- FROM: ${RM_USERID}@apache.org
- 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/dev/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.sha1
wget https://dist.apache.org/repos/dist/dev/nifi/nifi-minifi-cpp/${MINIFI_VERSION}/nifi-minifi-cpp-${MINIFI_VERSION}-source.tar.gz.sha256
# Verify the signature
gpg --verify nifi-minifi-cpp-${MINIFI_VERSION}-source.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.tar.gz
sha256sum 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!
- Developers in the community review the release candiate and reply to the vote email with their vote.
- After 72 hours if
- at least 3 binding (PMC members) cast +1 votes, and
- the positive binding votes out number any negative binding votes
- 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.
- 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 (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
- Move convenience binaries and related artifacts from dist/dev to dist/release:
$ 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}
- 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.
- Update the NiFi Web Page to indicate NEWS of the release as appropriate
- Create a proper signed tag of the released codebase based on the RC Tag craeted 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 . - Push the release tag to the official ASF repository.
$ git push asf rel/minifi-cpp-${MINIFI_VERSION} rel/minifi-cpp-${MINIFI_VERSION} - Update the release notes with the final date of the release.
- After the release has been complete for 24 hours send the release announcement.
- See here for an understanding of why you need to wait 24 hours
- The announcement should addressed as follows.
- TO: announce@apache.org, dev@nifi.apache.org
- REPLY-TO: dev@nifi.apache.org
- FROM: ${RM_USERID}@apache.org
- The subject should include [ANNOUNCE] Apache NiFi MiNiFi C++ x.y.z release.
- The text should on the template included below. +
Hello
The Apache NiFi team would like to announce the release of Apache NiFi MiNiFi C++ ${MINIFI_VERSION}.MiNiFi—a subproject of Apache NiFi—is a complementary data collection approach that supplements the core tenets of NiFi in dataflow management, focusing on the collection of data at the source of its creation.
Specific goals for the initial thrust of the MiNiFi effort comprise:
- Small size and low resource consumption
- Central management of agents
- Generation of data provenance (full chain of custody of information)
- Integration with NiFi for follow-on dataflow management
Note: Incorporate highlights about this release to give viewers a succint understanding about why they should care or what is now possible.
More details on Apache NiFi MiNiFi can be found here:
https://nifi.apache.org/minifi
The release artifacts can be downloaded from here:
https://nifi.apache.org/minifi/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-Version${MINIFI_VERSION}
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.
Hashes
sha1sum: 5b3797924eee1a59421ff216c542cb28c3564bfe
sha256sum: 9323165a2086053f8d1ad5478e2b7cc97f01fbc38ba133afe77badba1a446833
Signature
Signed with the key at http://people.apache.org/keys/committer/aldrin.asc