Author: joewitt
Date: Mon Jan 19 05:15:39 2015
New Revision: 1652906
URL: http://svn.apache.org/r1652906
Log:
review
Modified:
incubator/nifi/site/trunk/content/development/release-guide.md
Modified: incubator/nifi/site/trunk/content/development/release-guide.md
URL:
http://svn.apache.org/viewvc/incubator/nifi/site/trunk/content/development/release-guide.md?rev=1652906&r1=1652905&r2=1652906&view=diff
==============================================================================
--- incubator/nifi/site/trunk/content/development/release-guide.md (original)
+++ incubator/nifi/site/trunk/content/development/release-guide.md Mon Jan 19
05:15:39 2015
@@ -75,17 +75,20 @@ Follow the steps outlined in the [Quicks
At this point you're on the latest 'develop' branch and are able to build
the entire application
-Create a JIRA ticket for the release tasks and use that for the commit
messages. For example we'll consider NIFI-XYZ as our ticket.
+Create a JIRA ticket for the release tasks and use that ticket number for the
commit messages. For example we'll consider NIFI-123 as our ticket. Also
+have in mind the release version you are planning for. For example we'll
consider '0.0.1-incubating'.
Create the next version in JIRA if necessary so develop work can continue
towards that release.
Create new branch off develop named after the JIRA ticket or just use the
develop branch itself
+Change directory into that of the project you wish to release. For example
either `cd nifi` or `cd nar-maven-plugin`
+
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 key is available for signing as well
+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>
@@ -106,6 +109,35 @@ Ensure your settings.xml has been update
> </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 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 -Pcheck-licenses` 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-123 " -Darguments="-DskipTests"`.
+Maven will ask:
+`What is the release version for "Apache NiFi NAR Plugin"?
(org.apache.nifi:nar-maven-plugin) 0.0.1-incubating: :`
+Just hit enter to accept the default.
+Maven will then ask:
+`What is SCM release tag or label for "Apache NiFi NAR Plugin"?
(org.apache.nifi:nar-maven-plugin) nar-maven-plugin-0.0.1-incubating: : `
+Enter `nar-maven-plugin-0.0.1-incubating-RC1` or whatever the appropriate
release candidate (RC) number is.
+Maven will then ask:
+`What is the new development version for "Apache NiFi NAR Plugin"?
(org.apache.nifi:nar-maven-plugin) 0.0.2-incubating-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-123 "
-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-1010".`
+So if you go in a browser to
`https://repository.apache.org/#stagingRepositories` you should see
`orgapachenifi-1010`. If you click on that you
+can inspect the various staged artifacts.
+
+
[quickstart-guide]:
http://nifi.incubator.apache.org/development/quickstart.html
[release-manager]:
http://www.apache.org/dev/release-publishing.html#release_manager
[apache-license]: http://apache.org/licenses/LICENSE-2.0
