Author: joewitt
Date: Tue Dec 5 19:41:34 2017
New Revision: 1817225
URL: http://svn.apache.org/viewvc?rev=1817225&view=rev
Log:
added NIFI-4661 relevant include-grpc notes
Modified:
nifi/site/trunk/quickstart.html
nifi/site/trunk/release-guide.html
Modified: nifi/site/trunk/quickstart.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/quickstart.html?rev=1817225&r1=1817224&r2=1817225&view=diff
==============================================================================
--- nifi/site/trunk/quickstart.html (original)
+++ nifi/site/trunk/quickstart.html Tue Dec 5 19:41:34 2017
@@ -179,8 +179,9 @@ and for the partition(s) of interest add
<li>These settings have worked well <code>MAVEN_OPTS="-Xms1024m -Xmx3076m
-XX:MaxPermSize=256m"</code></li>
</ul>
</li>
-<li>Build the entire code base. In the root dir of the source tree run
<code>mvn -T C2.0 clean install</code>
-You can tweak the maven build settings as you like but the previous command
will execute with 2 threads per core.</li>
+<li>Build the entire code base. In the root dir of the source tree run
<code>mvn -T C2.0 clean install -Pinclude-grpc</code>
+You can tweak the maven build settings as you like but the previous command
will execute with 2 threads per core.
+You can omit the '-Pinclude-grpc' if you're not on a platform that
it supports.</li>
</ol>
<p>Now you should have a fully functioning build off the latest codebase.</p>
<p><em>NOTE</em>: During development it is not necessary to build the entire
code base. Typically, in case of a NAR bundle change you can build only the
particular bundle followed by running <code>mvn -T C2.0 clean install
-Ddir-only</code> in <code>nifi-assembly</code>.</p>
Modified: nifi/site/trunk/release-guide.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/release-guide.html?rev=1817225&r1=1817224&r2=1817225&view=diff
==============================================================================
--- nifi/site/trunk/release-guide.html (original)
+++ nifi/site/trunk/release-guide.html Tue Dec 5 19:41:34 2017
@@ -222,7 +222,8 @@ present at the root of the archive.</li>
</ul>
</li>
<li>Do all sources have necessary headers?<ul>
-<li>Unzip the sources file into a directory and execute <code>mvn install
-Pcontrib-check</code></li>
+<li>Unzip the sources file into a directory and execute <code>mvn install
-Pcontrib-check,include-grpc</code></li>
+<li>You can avoid 'include-grpc' if you're building on a system
that doesn't support it.</li>
</ul>
</li>
<li>Are there no unexpected binary files in the release?<ul>
@@ -287,7 +288,7 @@ There are other ways to ensure your PGP
</server>
</servers></code></pre>
</li>
-<li>Ensure the the full application builds and all tests work by executing a
parallel (multi-threaded) build.<pre><code> $ mvn -T 2.5C clean
install</code></pre>
+<li>Ensure the the full application builds and all tests work by executing a
parallel (multi-threaded) build.<pre><code> $ mvn -T 2.5C clean install
-Pinclude-grpc</code></pre>
</li>
<li>Startup and test the application with from the root source folder. After
a few seconds, NiFi should be up and
running at <a href="http://localhost:8080/nifi";><a
href="http://localhost:8080/nifi";>http://localhost:8080/nifi</a></a>.<pre><code>
$ cd nifi-assembly/target/nifi-${NIFI_VERSION}-bin/nifi-${NIFI_VERSION}
@@ -297,13 +298,13 @@ running at <a href="http://localhost:808
<li>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.)</li>
<li>Build the project with the <code>contrib-check</code> profile enabled to
validate contribution expectations and find any
-problems that must be addressed before proceeding. <pre><code> $ mvn install
-Pcontrib-check</code></pre>
+problems that must be addressed before proceeding. <pre><code> $ mvn install
-Pcontrib-check,include-grpc</code></pre>
</li>
</ol>
<h3 id="step-3-perform-the-release-rm-">Step 3. Perform the release (RM)</h3>
<ol>
<li>Now its time to have maven prepare the release with this
command.<pre><code> $ mvn --batch-mode release:prepare \
- -Psigned_release \
+ -Psigned_release,include-grpc \
-DscmCommentPrefix="NIFI-${JIRA_TICKET}-RC${RC} " \
-Dtag="nifi-${NIFI_VERSION}-RC${RC}" \
-DreleaseVersion="${NIFI_VERSION}" \
@@ -315,7 +316,7 @@ it may be necessary to run <code>$ mvn r
</li>
<li><p>If the preparation without problems, it is time to perform the release
and deploy artifacts to staging.</p>
<pre><code> $ mvn release:perform \
- -Psigned_release \
+ -Psigned_release,include-grpc \
-DscmCommentPrefix="${JIRA_TICKET}-RC${RC} " \
-Darguments="-DskipTests"</code></pre>
<p> When this completes the artifacts have been released to the Apache Nexus
staging repository, a local release branch
@@ -378,8 +379,8 @@ hashes and signatures to <code>https://d
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.</p>
-<p>So, as has been described here you can test the release process until you
get it right. The <code>mvn versions:set</code> and
-<code>mvn versions:commit</code> commands can come in handy to help do this so
you can set versions to something clearly release
+<p>So, as has been described here you can test the release process until you
get it right. The <code>mvn versions:set -Pinclude-grpc</code> and
+<code>mvn versions:commit -Pinclude-grpc</code> commands can come in handy to
help do this so you can set versions to something clearly release
test related.</p>
<h3 id="step-5-release-vote-rm-and-community-">Step 5. Release Vote (RM and
community)</h3>
<p>After the release source and artifacts are staged in the repositories
it's time for the RM to send a release vote to the
@@ -468,7 +469,7 @@ sha256sum nifi-${NIFI_VERSION}-source-re
# Verify the build works including release audit tool (RAT) checks
cd nifi-${NIFI_VERSION}
-mvn clean install -Pcontrib-check
+mvn clean install -Pcontrib-check,include-grpc
# Verify the contents contain a good README, NOTICE, and LICENSE.
