Author: chinmayskulkarni Date: Sat Dec 21 02:47:43 2019 New Revision: 1871876
URL: http://svn.apache.org/viewvc?rev=1871876&view=rev Log: PHOENIX-5646: Correct and update the release documentation Modified: phoenix/site/publish/index.html phoenix/site/publish/release.html phoenix/site/source/src/site/markdown/release.md Modified: phoenix/site/publish/index.html URL: http://svn.apache.org/viewvc/phoenix/site/publish/index.html?rev=1871876&r1=1871875&r2=1871876&view=diff ============================================================================== --- phoenix/site/publish/index.html (original) +++ phoenix/site/publish/index.html Sat Dec 21 02:47:43 2019 @@ -1,7 +1,7 @@ <!DOCTYPE html> <!-- - Generated by Apache Maven Doxia at 2019-12-13 + Generated by Apache Maven Doxia at 2019-12-20 Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin) --> <html xml:lang="en" lang="en"> Modified: phoenix/site/publish/release.html URL: http://svn.apache.org/viewvc/phoenix/site/publish/release.html?rev=1871876&r1=1871875&r2=1871876&view=diff ============================================================================== --- phoenix/site/publish/release.html (original) +++ phoenix/site/publish/release.html Sat Dec 21 02:47:43 2019 @@ -1,7 +1,7 @@ <!DOCTYPE html> <!-- - Generated by Apache Maven Doxia at 2019-11-21 + Generated by Apache Maven Doxia at 2019-12-20 Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin) --> <html xml:lang="en" lang="en"> @@ -168,7 +168,7 @@ <div class="page-header"> <h1>How to do a release</h1> </div> -<p>Following instructions walks you through releasing Phoenix-4.11.0-HBase-0.98. These steps needs to be repeated for all HBase branches.</p> +<p>Following instructions walks you through releasing Phoenix-4.15.0-HBase-1.3. These steps needs to be repeated for all HBase branches.</p> <div class="section"> <h2 id="Pre-Reqs">Pre-Reqs</h2> <ol style="list-style-type: decimal"> @@ -177,7 +177,7 @@ <li> <p>Set version to release and commit.</p> <div> <pre> -mvn versions:set -DnewVersion=4.11.0-HBase-0.98 -DgenerateBackupPoms=false +mvn versions:set -DnewVersion=4.15.0-HBase-1.3 -DgenerateBackupPoms=false </pre> </div></li> </ol> @@ -189,29 +189,30 @@ mvn versions:set -DnewVersion=4.11.0-HBa $ cd dev; ./make_rc.sh </pre> </div> - <p>Follow the instructions. Signed binary and source tars will be generated in <i>release</i> directory. As last part of this script, it will ask if you want to tag branch at this time. If all looks good then svn commit binary and source tars to <a class="externalLink" href="https://dist.apache.org/repos/dist/dev/phoenix";>https://dist.apache.org/repos/dist/dev/phoenix</a> </p> + <p>Follow the instructions. Signed binary and source tars will be generated in the <i>release</i> directory. As last part of this script, it will ask if you want to tag the branch at this time (sample tag: <tt>v4.15.0-HBase-1.3-rc0</tt>). If all looks good then svn commit binary and source tars to <a class="externalLink" href="https://dist.apache.org/repos/dist/dev/phoenix";>https://dist.apache.org/repos/dist/dev/phoenix</a> </p> </div> <div class="section"> <h2 id="Voting">Voting</h2> <ol style="list-style-type: decimal"> <li>Svn commit binary and source tars to <a class="externalLink" href="https://dist.apache.org/repos/dist/dev/phoenix";>https://dist.apache.org/repos/dist/dev/phoenix</a></li> - <li>Initiate vote email. See example <a class="externalLink" href="https://www.mail-archive.com/dev@phoenix.apache.org/msg41202.html";>here</a></li> + <li>Initiate the vote email. See example <a class="externalLink" href="https://www.mail-archive.com/dev@phoenix.apache.org/msg41202.html";>here</a></li> + <li>In case the RC (Release Candidate) is rejected via the vote, you will have to repeat the above process and re-initiate the vote for the next RC (RC0, RC1, etc.).</li> </ol> </div> <div class="section"> <h2 id="Release">Release</h2> <ol style="list-style-type: decimal"> - <li> <p>Once voting is successful, copy artifacts to <a class="externalLink" href="https://dist.apache.org/repos/dist/release/phoenix";>https://dist.apache.org/repos/dist/release/phoenix</a>:</p> + <li> <p>Once voting is successful (say for RC1), copy artifacts to <a class="externalLink" href="https://dist.apache.org/repos/dist/release/phoenix";>https://dist.apache.org/repos/dist/release/phoenix</a>:</p> <div> <pre> -svn mv https://dist.apache.org/repos/dist/dev/phoenix/apache-phoenix-4.11.0-HBase-0.98-rc1 - https://dist.apache.org/repos/dist/release/phoenix/apache-phoenix-4.11.0-HBase-0.98 +svn mv https://dist.apache.org/repos/dist/dev/phoenix/apache-phoenix-4.15.0-HBase-1.3-rc1 + https://dist.apache.org/repos/dist/release/phoenix/apache-phoenix-4.15.0-HBase-1.3 </pre> </div></li> <li> <p>Set release tag and commit: </p> <div> <pre> -git tag -a v4.11.0-HBase-0.98 v4.11.0-HBase-0.98-rc0 -m "Phoenix v4.11.0-HBase-0.98 release +git tag -a v4.15.0-HBase-1.3 v4.15.0-HBase-1.3-rc1 -m "Phoenix v4.15.0-HBase-1.3 release" </pre> </div></li> <li>Remove any obsolete releases on <a class="externalLink" href="https://dist.apache.org/repos/dist/release/phoenix";>https://dist.apache.org/repos/dist/release/phoenix</a> given the current release.</li> @@ -224,23 +225,26 @@ git tag -a v4.11.0-HBase-0.98 v4.11.0-HB </server> </pre> </div></li> - <li> <p>Release to maven (remove release directory from local repro if present): </p> + <li> <p>Note that the head of the branch may have progressed with patches between the time your vote was sent out and your vote passed, so you want to make sure that you revert the code base to the tag of the RC that passed. Release to maven (remove release directory from local repo if present): </p> <div> <pre> mvn clean deploy gpg:sign -DperformRelease=true -Dgpg.passphrase=[your_pass_phrase_here] --Dgpg.keyname=[your_key_here] -DskipTests -P release -pl phoenix-core,phoenix-pig,phoenix-tracing-webapp, -phoenix-queryserver,phoenix-spark,phoenix-flume,phoenix-pherf,phoenix-queryserver-client,phoenix-hive,phoenix-client,phoenix-server -am +-Dgpg.keyname=[your_key_here] -DskipTests -P release -pl phoenix-core,phoenix-tracing-webapp,phoenix-pherf,phoenix-client,phoenix-server -am </pre> - </div></li> - <li>Go to <a class="externalLink" href="https://repository.apache.org/#stagingRepositories";>https://repository.apache.org/#stagingRepositories</a> and <tt>close</tt> -> <tt>release</tt> the staged artifacts.</li> - <li> <p>Set version back to upcoming SNAPSHOT and commit:</p> + </div> <p><b>Note</b> <a class="externalLink" href="https://github.com/apache/phoenix-queryserver";>phoenix-queryserver</a> and <a class="externalLink" href="https://github.com/apache/phoenix-connectors";>phoenix-connectors</a> have been moved to their own repo and their releases are carried out separately.</p> <p><b>Note</b> You may need to skip JavaDoc generation by passing in the following flag: <tt>-Dmaven.javadoc.skip=true</tt></p></li> + <li> <p>Go to <a class="externalLink" href="https://repository.apache.org/#stagingRepositories";>https://repository.apache.org/#stagingRepositories</a> and <tt>close</tt> -> <tt>release</tt> the staged artifacts (takes a while so you may need to <tt>refresh</tt> multiple times).</p></li> + <li>Create new branch based on current release if needed, for ex: 4.15 branches in this case.</li> + <li> <p>Set version to the upcoming SNAPSHOT and commit:</p> <div> <pre> -mvn versions:set -DnewVersion=4.12.0-HBase-0.98-SNAPSHOT -DgenerateBackupPoms=false +mvn versions:set -DnewVersion=4.16.0-HBase-1.3-SNAPSHOT -DgenerateBackupPoms=false </pre> </div></li> - <li>Create new branch based on current release if needed.</li> + <li>Add documentation of released version to the <a class="externalLink" href="http://phoenix.apache.org/download.html";>downloads page</a> and <a class="externalLink" href="https://en.wikipedia.org/wiki/Apache_Phoenix";>wiki</a>.</li> + <li>Send out an announcement email. See example <a class="externalLink" href="https://www.mail-archive.com/dev@phoenix.apache.org/msg54764.html";>here</a>.</li> + <li>Bulk close Jiras that were marked for the release fixVersion.</li> </ol> + <p><b>Congratulations!</b></p> </div> </div> </div> Modified: phoenix/site/source/src/site/markdown/release.md URL: http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/release.md?rev=1871876&r1=1871875&r2=1871876&view=diff ============================================================================== --- phoenix/site/source/src/site/markdown/release.md (original) +++ phoenix/site/source/src/site/markdown/release.md Sat Dec 21 02:47:43 2019 @@ -1,5 +1,5 @@ # How to do a release -Following instructions walks you through releasing Phoenix-4.11.0-HBase-0.98. These steps needs to be repeated for all HBase branches. +Following instructions walks you through releasing Phoenix-4.15.0-HBase-1.3. These steps needs to be repeated for all HBase branches. ## Pre-Reqs 1. Make sure you have setup your user for release signing. Details http://www.apache.org/dev/release-signing.html. @@ -7,31 +7,32 @@ Following instructions walks you through 3. Set version to release and commit. <pre> - mvn versions:set -DnewVersion=4.11.0-HBase-0.98 -DgenerateBackupPoms=false + mvn versions:set -DnewVersion=4.15.0-HBase-1.3 -DgenerateBackupPoms=false </pre> ## Build binary and source tars <pre> $ cd dev; ./make_rc.sh </pre> -Follow the instructions. Signed binary and source tars will be generated in _release_ directory. As last part of this script, it will ask if you want to tag branch at this time. If all looks good then svn commit binary and source tars to https://dist.apache.org/repos/dist/dev/phoenix +Follow the instructions. Signed binary and source tars will be generated in the _release_ directory. As last part of this script, it will ask if you want to tag the branch at this time (sample tag: `v4.15.0-HBase-1.3-rc0`). If all looks good then svn commit binary and source tars to https://dist.apache.org/repos/dist/dev/phoenix ## Voting 1. Svn commit binary and source tars to https://dist.apache.org/repos/dist/dev/phoenix -2. Initiate vote email. See example [here](https://www.mail-archive.com/dev@phoenix.apache.org/msg41202.html) +2. Initiate the vote email. See example [here](https://www.mail-archive.com/dev@phoenix.apache.org/msg41202.html) +3. In case the RC (Release Candidate) is rejected via the vote, you will have to repeat the above process and re-initiate the vote for the next RC (RC0, RC1, etc.). ## Release -1. Once voting is successful, copy artifacts to https://dist.apache.org/repos/dist/release/phoenix: +1. Once voting is successful (say for RC1), copy artifacts to https://dist.apache.org/repos/dist/release/phoenix: <pre> - svn mv https://dist.apache.org/repos/dist/dev/phoenix/apache-phoenix-4.11.0-HBase-0.98-rc1 - https://dist.apache.org/repos/dist/release/phoenix/apache-phoenix-4.11.0-HBase-0.98 + svn mv https://dist.apache.org/repos/dist/dev/phoenix/apache-phoenix-4.15.0-HBase-1.3-rc1 + https://dist.apache.org/repos/dist/release/phoenix/apache-phoenix-4.15.0-HBase-1.3 </pre> 2. Set release tag and commit: <pre> - git tag -a v4.11.0-HBase-0.98 v4.11.0-HBase-0.98-rc0 -m "Phoenix v4.11.0-HBase-0.98 release + git tag -a v4.15.0-HBase-1.3 v4.15.0-HBase-1.3-rc1 -m "Phoenix v4.15.0-HBase-1.3 release" </pre> 3. Remove any obsolete releases on https://dist.apache.org/repos/dist/release/phoenix given the current release. @@ -45,17 +46,26 @@ Follow the instructions. Signed binary a </server> ``` -5. Release to maven (remove release directory from local repro if present): +5. Note that the head of the branch may have progressed with patches between the time your vote was sent out and your vote passed, so you want to make sure that you revert the code base to the tag of the RC that passed. Release to maven (remove release directory from local repo if present): <pre> mvn clean deploy gpg:sign -DperformRelease=true -Dgpg.passphrase=[your_pass_phrase_here] - -Dgpg.keyname=[your_key_here] -DskipTests -P release -pl phoenix-core,phoenix-pig,phoenix-tracing-webapp, - phoenix-queryserver,phoenix-spark,phoenix-flume,phoenix-pherf,phoenix-queryserver-client,phoenix-hive,phoenix-client,phoenix-server -am + -Dgpg.keyname=[your_key_here] -DskipTests -P release -pl phoenix-core,phoenix-tracing-webapp,phoenix-pherf,phoenix-client,phoenix-server -am </pre> -6. Go to https://repository.apache.org/#stagingRepositories and <code>close</code> -> <code>release</code> the staged artifacts. -7. Set version back to upcoming SNAPSHOT and commit: + + **Note** [phoenix-queryserver](https://github.com/apache/phoenix-queryserver) and [phoenix-connectors](https://github.com/apache/phoenix-connectors) have been moved to their own repo and their releases are carried out separately. + + **Note** You may need to skip JavaDoc generation by passing in the following flag: `-Dmaven.javadoc.skip=true ` + +6. Go to https://repository.apache.org/#stagingRepositories and <code>close</code> -> <code>release</code> the staged artifacts (takes a while so you may need to `refresh` multiple times). +7. Create new branch based on current release if needed, for ex: 4.15 branches in this case. +8. Set version to the upcoming SNAPSHOT and commit: <pre> - mvn versions:set -DnewVersion=4.12.0-HBase-0.98-SNAPSHOT -DgenerateBackupPoms=false + mvn versions:set -DnewVersion=4.16.0-HBase-1.3-SNAPSHOT -DgenerateBackupPoms=false </pre> -7. Create new branch based on current release if needed. +9. Add documentation of released version to the [downloads page](http://phoenix.apache.org/download.html) and [wiki](https://en.wikipedia.org/wiki/Apache_Phoenix). +10. Send out an announcement email. See example [here](https://www.mail-archive.com/dev@phoenix.apache.org/msg54764.html). +11. Bulk close Jiras that were marked for the release fixVersion. + +**Congratulations!**
