You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@polygene.apache.org by pa...@apache.org on 2015/07/25 01:16:46 UTC
svn commit: r1692596 - in /zest/site/content/java/develop: build-system.html
releasing-apache.html
Author: paulmerlin
Date: Fri Jul 24 23:16:46 2015
New Revision: 1692596
URL: http://svn.apache.org/r1692596
Log:
ZEST-100 Release howto refinements
Modified:
zest/site/content/java/develop/build-system.html
zest/site/content/java/develop/releasing-apache.html
Modified: zest/site/content/java/develop/build-system.html
URL: http://svn.apache.org/viewvc/zest/site/content/java/develop/build-system.html?rev=1692596&r1=1692595&r2=1692596&view=diff
==============================================================================
--- zest/site/content/java/develop/build-system.html (original)
+++ zest/site/content/java/develop/build-system.html Fri Jul 24 23:16:46 2015
@@ -121,7 +121,7 @@ PostgreSQL for <code class="literal">ext
</li><li class="listitem">
MySQL for <code class="literal">extensions/entitystore-sql</code> (need setup, see test source)
</li></ul></div></div><div class="section" title="Performance tests"><div class="titlepage"><div><div><h5 class="title"><a id="_performance_tests"></a>Performance tests</h5></div></div></div><p>Performance tests provide performance mesurements for typical Zest⢠use cases.
-They are not part of the default build and are located in the <code class="literal">tests/performance</code> directory of the SDK.</p><p>They can be run with the following Gradle command:</p><pre class="programlisting brush: bash">./gradlew :org.qi4j.tests:org.qi4j.test.performance:testPerf</pre><p>Results will then be available in the test reports.</p></div></div><div class="section" title="Build for releases"><div class="titlepage"><div><div><h4 class="title"><a id="_build_for_releases"></a>Build for releases</h4></div></div></div><div class="important" title="Important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p>Remember that if a <code class="literal">version</code> property is not defined, the build system will refuse to make a release and upload.</p></div><p>The Zest⢠SDK build system is setup for an easy release process.
+They are not part of the default build and are located in the <code class="literal">tests/performance</code> directory of the SDK.</p><p>They can be run with the following Gradle command:</p><pre class="programlisting brush: bash">./gradlew :org.qi4j.tests:org.qi4j.test.performance:testPerf</pre><p>Results will then be available in the test reports.</p></div></div><div class="section" title="Documentation generation"><div class="titlepage"><div><div><h4 class="title"><a id="_documentation_generation"></a>Documentation generation</h4></div></div></div><p>The build generates a documentation minisite:</p><pre class="programlisting brush: bash">./gradlew -p manual website</pre><p>Output is in <code class="literal">~/manual/build/docs/website</code>.</p><p>Youâll need Asciidoc and docbook-xsl installed.</p></div><div class="section" title="Build for releases"><div class="titlepage"><div><div><h4 class="title"><a id="_build_for_releases"></a>Build for releases</h4></div></div></div><
div class="important" title="Important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p>Remember that if a <code class="literal">version</code> property is not defined, the build system will refuse to make a release and upload.</p></div><p>The Zest⢠SDK build system is setup for an easy release process.
This is very useful to the Zest⢠Core Team but can also be useful to third parties that want to cut a in-house release.
In this regard, we try to make every aspect of the release process usable for such cases.</p><p>The following sections describe various aspects of the release process.
By default you need to have a proper PGP setup, see below.</p><div class="section" title="Release Criteria"><div class="titlepage"><div><div><h5 class="title"><a id="_release_criteria"></a>Release Criteria</h5></div></div></div><p>The Zest⢠SDK modules are of varying maturity level and we try to maintain a STATUS (<code class="literal">dev-status.xml</code>) file indicating
Modified: zest/site/content/java/develop/releasing-apache.html
URL: http://svn.apache.org/viewvc/zest/site/content/java/develop/releasing-apache.html?rev=1692596&r1=1692595&r2=1692596&view=diff
==============================================================================
--- zest/site/content/java/develop/releasing-apache.html (original)
+++ zest/site/content/java/develop/releasing-apache.html Fri Jul 24 23:16:46 2015
@@ -66,31 +66,36 @@
})();
</script>
- </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common" class="logo"><a href="index.html"><img src="images/logo-standard.png" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common" class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span class="section"><a href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><span xmlns="" href="tutorials.html">Tutorials</span></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><a href="libraries.html">Libraries</a></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</a></span></dt><dt><span class="section"><a href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common" class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span class="section"><a href="tutorials.html#_overview">Overview</a></span></dt><dt><span class="section"><a href="two-minutes-intro.html">Zest⢠in 2 minutes</a></span></dt><dt><span class="section"><a href="ten-minutes-intro.html">Zest⢠in 10 minutes</a></span></dt><dt><span class="section"><a href="thirty-minutes-intro.html">Zest⢠in 30 minutes</a></span></dt><dt><span class="section"><a href="two-hours-intro.html">Zest⢠in 2 hours</a></span></dt><dt><span class="section"><a href="howto-depend-on-zest.html">Depend on Zest⢠in your build</a></span></dt><dt><span class="section"><a href="howto-assemble-application.html">Assemble an Application</a></span></dt><dt><span class="section"><a href="tut-composites.html">Transient Composites Tutorial</a></span></dt><dt><span class="section">
<a href="tut-services.html">Services Composites Tutorial</a></span></dt><dt><span class="section"><a href="howto-contextual-fragments.html">Use contextual fragments</a></span></dt><dt><span class="section"><a href="howto-leverage-properties.html">Leverage Properties</a></span></dt><dt><span class="section"><a href="howto-create-constraint.html">Create a Constraint</a></span></dt><dt><span class="section"><a href="howto-create-concern.html">Create a Concern</a></span></dt><dt><span class="section"><a href="howto-create-sideeffect.html">Create a SideEffect</a></span></dt><dt><span class="section"><a href="howto-create-entity.html">Create an Entity</a></span></dt><dt><span class="section"><a href="howto-configure-service.html">Configure a Service</a></span></dt><dt><span class="section"><a href="howto-invocation-annotation.html">Use @Invocation</a></span></dt><dt><span class="section"><a href="howto-use-io.html">Use I/O API</a></span></dt><dt><span class="section"><a href="build-system
.html">Zest⢠Build System</a></span></dt><dt><span class="section"><a href="community-docs.html">Writing Zest⢠Documentation</a></span></dt><dt><span class="section"><span xmlns="" href="releasing-apache.html">Releasing Zestâ¢</span></span></dt></dl></div></div><div class="section" title="Releasing Zestâ¢"><div class="titlepage"><div><div><h3 class="title"><a id="releasing-apache"></a>Releasing Zestâ¢</h3></div></div></div><p>This tutorial is intended for Apache Zest⢠commiters who want to release a new version of Apache Zest⢠(Java Edition) at The Apache Software Foundation.
+ </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common" class="logo"><a href="index.html"><img src="images/logo-standard.png" /></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common" class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span class="section"><a href="index.html#home">Zestâ¢</a></span></dt><dt><span class="section"><a href="intro.html">Introduction</a></span></dt><dt><span class="section"><span xmlns="" href="tutorials.html">Tutorials</span></span></dt><dt><span class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a href="samples.html">Samples</a></span></dt><dt><span class="section"><a href="core.html">Core</a></span></dt><dt><span class="section"><a href="libraries.html">Libraries</a></span></dt><dt><span class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a href="tools.html">Tools</a></span></dt><dt><span class="section"><a href="glossary.htm
l">Glossary </a></span></dt></dl></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common" class="sub-nav"><div xmlns="http://www.w3.org/1999/xhtml" class="toc"><dl><dt><span class="section"><a href="tutorials.html#_overview">Overview</a></span></dt><dt><span class="section"><a href="two-minutes-intro.html">Zest⢠in 2 minutes</a></span></dt><dt><span class="section"><a href="ten-minutes-intro.html">Zest⢠in 10 minutes</a></span></dt><dt><span class="section"><a href="thirty-minutes-intro.html">Zest⢠in 30 minutes</a></span></dt><dt><span class="section"><a href="two-hours-intro.html">Zest⢠in 2 hours</a></span></dt><dt><span class="section"><a href="howto-depend-on-zest.html">Depend on Zest⢠in your build</a></span></dt><dt><span class="section"><a href="howto-assemble-application.html">Assemble an Application</a></span></dt><dt><span class="section"><a href="tut-composites.html">Transient Composites Tutorial</a></span></dt><dt><span class="section">
<a href="tut-services.html">Services Composites Tutorial</a></span></dt><dt><span class="section"><a href="howto-contextual-fragments.html">Use contextual fragments</a></span></dt><dt><span class="section"><a href="howto-leverage-properties.html">Leverage Properties</a></span></dt><dt><span class="section"><a href="howto-create-constraint.html">Create a Constraint</a></span></dt><dt><span class="section"><a href="howto-create-concern.html">Create a Concern</a></span></dt><dt><span class="section"><a href="howto-create-sideeffect.html">Create a SideEffect</a></span></dt><dt><span class="section"><a href="howto-create-entity.html">Create an Entity</a></span></dt><dt><span class="section"><a href="howto-configure-service.html">Configure a Service</a></span></dt><dt><span class="section"><a href="howto-invocation-annotation.html">Use @Invocation</a></span></dt><dt><span class="section"><a href="howto-use-io.html">Use I/O API</a></span></dt><dt><span class="section"><a href="build-system
.html">Zest⢠Build System</a></span></dt><dt><span class="section"><a href="community-docs.html">Writing Zest⢠Documentation</a></span></dt><dt><span class="section"><span xmlns="" href="releasing-apache.html">Releasing Zestâ¢</span></span></dt></dl></div></div><div class="section" title="Releasing Zestâ¢"><div class="titlepage"><div><div><h3 class="title"><a id="releasing-apache"></a>Releasing Zestâ¢</h3></div></div></div><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>You need a unix-like environment to actually perform the release process.
+This tutorial is known to work on Linux and Mac.</p></div><p>This tutorial is intended for Apache Zest⢠commiters who want to release a new version of Apache Zest⢠(Java Edition) at The Apache Software Foundation.
It describes the tools and processes of a typical release.</p><p>It is intended to be a recommendation of best practices for the Apache Zest⢠project.
-The instructions provided here are consistent with, but not a replacement for the <a class="ulink" href="https://www.apache.org/dev/release.html" target="_top">ASF Release Guidelines</a>.</p><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>You need a unix-like environment to actually perform the release process.
-This tutorial is known to work on Linux and Mac.</p></div><p>Before going further you obviously should have read the <a class="link" href="build-system.html" title="Zest⢠Build System">Build System</a> tutorial and already built Zest⢠from source, signing included.</p><div class="section" title="Preparing a release"><div class="titlepage"><div><div><h4 class="title"><a id="_preparing_a_release"></a>Preparing a release</h4></div></div></div><div class="section" title="Select a Release Manager"><div class="titlepage"><div><div><h5 class="title"><a id="_select_a_release_manager"></a>Select a Release Manager</h5></div></div></div><p>A Zest committer (normally one of the development team) should post an email to the development list proposing that a release be made and nominating a release manager.
+The instructions provided here are consistent with, but not a replacement for the <a class="ulink" href="https://www.apache.org/dev/release.html" target="_top">ASF Release Guidelines</a>.</p><div class="section" title="Preparing a release"><div class="titlepage"><div><div><h4 class="title"><a id="_preparing_a_release"></a>Preparing a release</h4></div></div></div><div class="section" title="Select a Release Manager"><div class="titlepage"><div><div><h5 class="title"><a id="_select_a_release_manager"></a>Select a Release Manager</h5></div></div></div><p>A Zest committer (normally one of the development team) should post an email to the development list proposing that a release be made and nominating a release manager.
Typically, the proposer volunteers as the release manager and it passes by <a class="ulink" href="https://www.apache.org/foundation/glossary.html#LazyConsensus" target="_top">lazy consensus</a>.</p></div><div class="section" title="Clone/Checkout all repositories"><div class="titlepage"><div><div><h5 class="title"><a id="_clone_checkout_all_repositories"></a>Clone/Checkout all repositories</h5></div></div></div><p>Clone/checkout all needed repositories, next to each other:</p><pre class="programlisting brush: shell">mkdir zest-repos
cd zest-repos
git clone https://git-wip-us.apache.org/repos/asf/zest-java.git zest-java
-svn checkout https://svn.apache.org/repos/asf/zest/ zest-svn
-svn checkout https://dist.apache.org/repos/dist/dev/zest/ zest-dist-dev
-svn checkout https://dist.apache.org/repos/dist/release/zest/ zest-dist-release</pre><p>You should then get the following directory tree:</p><pre class="programlisting brush: text">.
+svn checkout https://svn.apache.org/repos/asf/zest/ zest-web
+svn checkout --depth empty https://dist.apache.org/repos/dist/ zest-dist
+cd zest-dist
+svn update --set-depth immediates dev
+svn update --set-depth immediates release
+svn update --set-depth infinity dev/zest
+svn update --set-depth infinity release/zest</pre><p>You should then get the following directory tree:</p><pre class="programlisting brush: text">.
âââ zest-repos
âââ zest-java # Apache Zest⢠(Java Edition) source
- âââ zest-svn # https://zest.apache.org/ website
- âââ zest-dist-dev # Releases candidate distributions
- âââ zest-dist-release # Releases distributions</pre></div><div class="section" title="Build Apache Zest⢠(Java Edition)"><div class="titlepage"><div><div><h5 class="title"><a id="_build_apache_zest_java_edition"></a>Build Apache Zest⢠(Java Edition)</h5></div></div></div><p>Ensure you can test, build and sign Zest, including artifact signing, see the <a class="link" href="build-system.html" title="Zest⢠Build System">Build System</a> tutorial.</p></div><div class="section" title="Install Jekyll"><div class="titlepage"><div><div><h5 class="title"><a id="_install_jekyll"></a>Install Jekyll</h5></div></div></div><p>Moreover, you will need to have a valid <a class="ulink" href="http://jekyllrb.com/" target="_top">Jekyll</a> installation as the Apache Zest⢠<a class="ulink" href="https://zest.apache.org/" target="_top">website</a> is generated using it.</p></div><div class="section" title="Setup git flow"><div class="titlepage"><div><div><h5 class
="title"><a id="_setup_git_flow"></a>Setup git flow</h5></div></div></div><p><code class="literal">git-flow</code> is a git extension that add git commands to easily use the git flow branching model the Apache Zest⢠project follows.
-See the <a class="ulink" href="https://github.com/nvie/gitflow/wiki/Installation" target="_top">installation instructions</a>.</p></div><div class="section" title="Setup git signing"><div class="titlepage"><div><div><h5 class="title"><a id="_setup_git_signing"></a>Setup git signing</h5></div></div></div><p>Ensure you can sign git tags.</p><pre class="programlisting brush: shell">git config --global user.signingkey <YOUR-PGP-ID></pre><p>See the <a class="ulink" href="https://git-scm.com/book/tr/v2/Git-Tools-Signing-Your-Work" target="_top">Git Tools - Signing Your Work</a> section of the Git book.</p></div><div class="section" title="Setup Apache Nexus credentials"><div class="titlepage"><div><div><h5 class="title"><a id="_setup_apache_nexus_credentials"></a>Setup Apache Nexus credentials</h5></div></div></div><p>See the Apache <a class="ulink" href="https://www.apache.org/dev/publishing-maven-artifacts.html" target="_top">Publishing Maven Artifacts</a> guide and the Apache Zes
t⢠(Java Edition) <a class="link" href="build-system.html" title="Zest⢠Build System">Build System</a> tutorial.</p></div><div class="section" title="Update the KEYS file if needed."><div class="titlepage"><div><div><h5 class="title"><a id="_update_the_literal_keys_literal_file_if_needed"></a>Update the <code class="literal">KEYS</code> file if needed.</h5></div></div></div><p>The reference <code class="literal">KEYS</code> file can be found at the <code class="literal">zest-java</code> repositoryâs root.</p><p>Diff the ones present in the <code class="literal">dev</code> and <code class="literal">release</code> distribution areas:</p><pre class="programlisting brush: shell">diff zest-java/KEYS zest-dist-dev/KEYS
-diff zest-java/KEYS zest-dist-release/KEYS</pre><p>And update them if needed:</p><pre class="programlisting brush: shell">cp zest-java/KEYS zest-dist-dev/KEYS
-cp zest-java/KEYS zest-dist-release/KEYS
-cd zest-dist-dev
-svn add KEYS
-svn commit -m "zest: updating KEYS in dist/dev/zest"
-cd ..
-cd zest-dist-release
-svn add KEYS
-svn commit -m "zest: updating KEYS in dist/release/zest"</pre></div></div><div class="section" title="Creating a Release Candidate"><div class="titlepage"><div><div><h4 class="title"><a id="_creating_a_release_candidate"></a>Creating a Release Candidate</h4></div></div></div><div class="section" title="Resolve JIRA issues"><div class="titlepage"><div><div><h5 class="title"><a id="_resolve_jira_issues"></a>Resolve JIRA issues</h5></div></div></div><p>Resolve all issues on that version!
+ âââ zest-web # https://zest.apache.org/ website
+ âââ zest-dist
+ âââ dev
+ | âââ zest # Releases candidate distributions
+ âââ release
+ âââ zest # Releases distributions</pre><div class="tip" title="Tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>From now on, all command line snippets start from the <code class="literal">zest-repos</code> directory.</p></div></div><div class="section" title="Build Apache Zest⢠(Java Edition)"><div class="titlepage"><div><div><h5 class="title"><a id="_build_apache_zest_java_edition"></a>Build Apache Zest⢠(Java Edition)</h5></div></div></div><p>Ensure you can test, build Apache Zest⢠(Java Edition), including the documentation minisite generation using Asciidoc and artifact signing.</p><p>Here is what should pass before going further:</p><pre class="programlisting brush: shell">cd zest-java
+./gradlew -Dversion="<RELEASE-VERSION>" website signArchives</pre><p>See the <a class="link" href="build-system.html" title="Zest⢠Build System">Build System</a> tutorial for details.</p></div><div class="section" title="Install Jekyll"><div class="titlepage"><div><div><h5 class="title"><a id="_install_jekyll"></a>Install Jekyll</h5></div></div></div><p>Moreover, you will need to have a valid <a class="ulink" href="http://jekyllrb.com/" target="_top">Jekyll</a> installation as the Apache Zest⢠<a class="ulink" href="https://zest.apache.org/" target="_top">website</a> is generated using it.</p></div><div class="section" title="Setup git flow"><div class="titlepage"><div><div><h5 class="title"><a id="_setup_git_flow"></a>Setup git flow</h5></div></div></div><p><code class="literal">git-flow</code> is a git extension that add git commands to easily use the git flow branching model the Apache Zest⢠project follows.
+See the <a class="ulink" href="https://github.com/nvie/gitflow/wiki/Installation" target="_top">installation instructions</a>.</p></div><div class="section" title="Setup git signing"><div class="titlepage"><div><div><h5 class="title"><a id="_setup_git_signing"></a>Setup git signing</h5></div></div></div><p>Ensure you can sign git tags.</p><pre class="programlisting brush: shell">git config --global user.signingkey <YOUR-PGP-ID></pre><p>See the <a class="ulink" href="https://git-scm.com/book/tr/v2/Git-Tools-Signing-Your-Work" target="_top">Git Tools - Signing Your Work</a> section of the Git book.</p></div><div class="section" title="Setup Apache Nexus credentials"><div class="titlepage"><div><div><h5 class="title"><a id="_setup_apache_nexus_credentials"></a>Setup Apache Nexus credentials</h5></div></div></div><p>See the Apache <a class="ulink" href="https://www.apache.org/dev/publishing-maven-artifacts.html" target="_top">Publishing Maven Artifacts</a> guide and the Apache Zes
t⢠(Java Edition) <a class="link" href="build-system.html" title="Zest⢠Build System">Build System</a> tutorial.</p></div><div class="section" title="Update the KEYS files if needed."><div class="titlepage"><div><div><h5 class="title"><a id="_update_the_literal_keys_literal_files_if_needed"></a>Update the <code class="literal">KEYS</code> files if needed.</h5></div></div></div><p>The reference <code class="literal">KEYS</code> file can be found at the <code class="literal">zest-java</code> repositoryâs root, that is <code class="literal">zest-java/KEYS</code>.
+Ensure that it contains your public key.</p><p>Next, diff it against the ones present in the <code class="literal">dev</code> and <code class="literal">release</code> distribution areas:</p><pre class="programlisting brush: shell">diff zest-java/KEYS zest-dist/dev/zest/KEYS
+diff zest-java/KEYS zest-dist/release/zest/KEYS</pre><p>And update them if needed:</p><pre class="programlisting brush: shell">cp zest-java/KEYS zest-dist/dev/zest/KEYS
+cp zest-java/KEYS zest-dist/release/zest/KEYS
+cd zest-dist/dev/zest
+svn add dev/zest/KEYS release/zest/KEYS
+svn commit -m "zest: updating Zest KEYS"</pre></div></div><div class="section" title="Creating a Release Candidate"><div class="titlepage"><div><div><h4 class="title"><a id="_creating_a_release_candidate"></a>Creating a Release Candidate</h4></div></div></div><div class="section" title="Resolve JIRA issues"><div class="titlepage"><div><div><h5 class="title"><a id="_resolve_jira_issues"></a>Resolve JIRA issues</h5></div></div></div><p>Resolve all issues on that version!
They can be resolved by:</p><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem">
fixing
</li><li class="listitem">
@@ -100,15 +105,17 @@ changing their fix version to another un
</li></ul></div><p>See the <a class="ulink" href="https://issues.apache.org/jira/browse/ZEST" target="_top">ZEST</a> project on JIRA.</p></div><div class="section" title="Prepare Release-Notes"><div class="titlepage"><div><div><h5 class="title"><a id="_prepare_release_notes"></a>Prepare Release-Notes</h5></div></div></div><p>Apache Zest⢠release-notes are generated from JIRA issues.</p><p>Open the target Zest⢠versionâs release-notes in <a class="ulink" href="https://issues.apache.org/jira/browse/ZEST/?selectedTab=com.atlassian.jira.jira-projects-plugin:roadmap-panel" target="_top">JIRA</a> and review them.</p><p>JIRA can produces release-notes as HTML or plain-text.
Set it up to generate plain-text release-notes.</p><p>We will need these in several formats.
Starting from the plain-text one we will generate the others.</p><p>First save the text-plain release-notes in a file named <code class="literal">apache-zest-java-<RELEASE-VERSION>-release-notes.txt</code>.
-A good place for this file would be in the <code class="literal">zest-repos</code> directory created earlier, alongside all repositories.</p><p>Convert to Asciidoc:</p><pre class="programlisting brush: shell">cat apache-zest-java-<RELEASE-VERSION>-release-notes.txt | \
+A good place for this file would be in the <code class="literal">zest-repos</code> directory created earlier, alongside all repositories.</p><p>Convert to Asciidoc:</p><pre class="programlisting brush: shell">cat "apache-zest-java-<RELEASE-VERSION>-release-notes.txt" | \
sed -e "s/* \[ZEST-\([0-9]\)*\]/- https:\/\/issues.apache.org\/jira\/browse\/ZEST-\1[ZEST-\1]/" | \
- sed -e "s/^\*\*/===/" > apache-zest-java-<RELEASE-VERSION>-release-notes.adoc</pre><p>Convert to Markdown:</p><pre class="programlisting brush: shell">cat apache-zest-java-<RELEASE-VERSION>-release-notes.txt | \
+ sed -e "s/^\*\*/===/" > "apache-zest-java-<RELEASE-VERSION>-release-notes.adoc"</pre><p>Convert to Markdown:</p><pre class="programlisting brush: shell">cat "apache-zest-java-<RELEASE-VERSION>-release-notes.txt" | \
sed -e "s/* \[ZEST-\([0-9]\)*\]/- [ZEST-\1](https:\/\/issues.apache.org\/jira\/browse\/ZEST-\1)/" | \
- sed -e "s/^\*\*/###/" > apache-zest-java-<RELEASE-VERSION>-release-notes.md</pre><p>You should then have the two following files:</p><pre class="programlisting brush: shell">.
+ sed -e "s/^\*\*/###/" > "apache-zest-java-<RELEASE-VERSION>-release-notes.md"</pre><p>You should then have the following files:</p><pre class="programlisting brush: shell">.
âââ apache-zest-java-<RELEASE-VERSION>-release-notes.txt
âââ apache-zest-java-<RELEASE-VERSION>-release-notes.adoc
-âââ apache-zest-java-<RELEASE-VERSION>-release-notes.md</pre><p>We will use them later.</p></div><div class="section" title="Create a RC branch"><div class="titlepage"><div><div><h5 class="title"><a id="_create_a_rc_branch"></a>Create a RC branch</h5></div></div></div><p>We use <code class="literal"><RELEASE-VERSION>-RC#</code> where <code class="literal">RELEASE-VERSION</code> is the target release version and <code class="literal">RC#</code> for Release Candidate and an incremental number in case the release process has to be done several times.</p><pre class="programlisting brush: shell">git flow release start <RELEASE-VERSION>-RC#</pre><p>This will eventually generates a <code class="literal"><RELEASE-VERSION>-RC#</code> tag that we will rename to <code class="literal"><RELEASE-VERSION></code> if the vote passes, see below.</p></div><div class="section" title="Audit artifacts and distributions"><div class="titlepage"><div><div><h5 cla
ss="title"><a id="_audit_artifacts_and_distributions"></a>Audit artifacts and distributions</h5></div></div></div><p>Make a complete build, deploying maven artifacts locally:</p><pre class="programlisting brush: shell">./gradlew -Dversion=<RELEASE-VERSION> -PuploadRepository="file://$(pwd)/build/repositories/zest-java" \
- clean buildAll checkDists uploadArchives</pre><p>Review maven artifacts in <code class="literal">build/repositories/zest-java</code>.</p><p>Also review the release distributions in <code class="literal">build/distributions</code> where you should find the following files:</p><pre class="programlisting brush: shell">.
+âââ apache-zest-java-<RELEASE-VERSION>-release-notes.md</pre><p>We will use them later.</p></div><div class="section" title="Create a RC branch"><div class="titlepage"><div><div><h5 class="title"><a id="_create_a_rc_branch"></a>Create a RC branch</h5></div></div></div><p>We use <code class="literal"><RELEASE-VERSION>-RC#</code> where <code class="literal">RELEASE-VERSION</code> is the target release version and <code class="literal">RC#</code> for Release Candidate and an incremental number in case the release process has to be done several times.</p><pre class="programlisting brush: shell">cd zest-java
+git flow release start "<RELEASE-VERSION>-RC#"</pre><p>This will eventually generates a <code class="literal"><RELEASE-VERSION>-RC#</code> tag that we will amend with a <code class="literal"><RELEASE-VERSION></code> signed tag if the vote passes, see below.</p></div><div class="section" title="Audit artifacts and distributions"><div class="titlepage"><div><div><h5 class="title"><a id="_audit_artifacts_and_distributions"></a>Audit artifacts and distributions</h5></div></div></div><p>Make a complete build, deploying maven artifacts locally:</p><pre class="programlisting brush: shell">cd zest-java
+./gradlew -Dversion="<RELEASE-VERSION>" -PuploadRepository="file://$(pwd)/build/repositories/zest-java" \
+ clean assemble checkDists uploadArchives</pre><p>Review maven artifacts in <code class="literal">build/repositories/zest-java</code>.</p><p>Also review the release distributions in <code class="literal">build/distributions</code> where you should find the following files:</p><pre class="programlisting brush: shell">.
âââ apache-zest-java-<RELEASE-VERSION>-bin.tgz
âââ apache-zest-java-<RELEASE-VERSION>-bin.tgz.MD5
âââ apache-zest-java-<RELEASE-VERSION>-bin.tgz.SHA-512
@@ -124,9 +131,32 @@ A good place for this file would be in t
âââ apache-zest-java-<RELEASE-VERSION>-src.zip
âââ apache-zest-java-<RELEASE-VERSION>-src.zip.MD5
âââ apache-zest-java-<RELEASE-VERSION>-src.zip.SHA-512
-âââ apache-zest-java-<RELEASE-VERSION>-src.zip.asc</pre><p>If any, make the required changes, commit them and iterate.</p></div><div class="section" title="Close the RC branch"><div class="titlepage"><div><div><h5 class="title"><a id="_close_the_rc_branch"></a>Close the RC branch</h5></div></div></div><p>Once you are satisfied with the produced artifacts, close the release candidate branch:</p><pre class="programlisting brush: shell">git flow release finish <RELEASE-VERSION>-RC#</pre></div><div class="section" title="Checkout the RC tag"><div class="titlepage"><div><div><h5 class="title"><a id="_checkout_the_rc_tag"></a>Checkout the RC tag</h5></div></div></div><p>To build the release candidate bits, we need to checkout the release candidate tag, that will eventually be promoted as a signed release tag, because the Apache Zest⢠build system generates versionning information based on git metadata.</p><pre class="programlisting brush: shell">git checkou
t <RELEASE-VERSION>-RC#</pre></div><div class="section" title="Build RC artifacts and distributions"><div class="titlepage"><div><div><h5 class="title"><a id="_build_rc_artifacts_and_distributions"></a>Build RC artifacts and distributions</h5></div></div></div><pre class="programlisting brush: shell">./gradlew -Dversion=<RELEASE-VERSION> clean check buildAll checkDists</pre></div><div class="section" title="Stage RC maven artifacts"><div class="titlepage"><div><div><h5 class="title"><a id="_stage_rc_maven_artifacts"></a>Stage RC maven artifacts</h5></div></div></div><p>Stage artifacts to <a class="ulink" href="https://repository.apache.org/" target="_top">repository.apache.org</a> :</p><pre class="programlisting brush: shell">./gradlew -Dversion=<RELEASE-VERSION> uploadArchives</pre><p>Close the staging Nexus repository by following the <a class="ulink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#close-stage" target="_top">Closing the staged re
pository</a> guide.</p></div><div class="section" title="Upload RC distributions"><div class="titlepage"><div><div><h5 class="title"><a id="_upload_rc_distributions"></a>Upload RC distributions</h5></div></div></div><p>Upload source and binary distributions, checksums and signatures to <a class="ulink" href="https://dist.apache.org/repos/dist/dev/zest/" target="_top">dist.apache.org/repos/dist/dev/zest</a>:</p><pre class="programlisting brush: shell">cp zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-src* zest-dist-dev/
-cp zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-bin* zest-dist-dev/
-cd zest-dist-dev
+âââ apache-zest-java-<RELEASE-VERSION>-src.zip.asc</pre><p>If any, make the required changes, commit them and iterate.</p></div><div class="section" title="Close the RC branch"><div class="titlepage"><div><div><h5 class="title"><a id="_close_the_rc_branch"></a>Close the RC branch</h5></div></div></div><p>Once you are satisfied with the produced artifacts, close the release candidate branch:</p><pre class="programlisting brush: shell">cd zest-java
+git flow release finish "<RELEASE-VERSION>-RC#"</pre></div><div class="section" title="Checkout the RC tag"><div class="titlepage"><div><div><h5 class="title"><a id="_checkout_the_rc_tag"></a>Checkout the RC tag</h5></div></div></div><p>To build the release candidate bits, we need to checkout the release candidate tag, that will eventually be promoted as a signed release tag, because the Apache Zest⢠build system generates versionning information based on git metadata.</p><pre class="programlisting brush: shell">cd zest-java
+git checkout "<RELEASE-VERSION>-RC#"</pre></div><div class="section" title="Build RC artifacts and distributions"><div class="titlepage"><div><div><h5 class="title"><a id="_build_rc_artifacts_and_distributions"></a>Build RC artifacts and distributions</h5></div></div></div><pre class="programlisting brush: shell">cd zest-java
+./gradlew -Dversion="<RELEASE-VERSION>" clean assemble</pre></div><div class="section" title="Stage RC maven artifacts"><div class="titlepage"><div><div><h5 class="title"><a id="_stage_rc_maven_artifacts"></a>Stage RC maven artifacts</h5></div></div></div><p>Stage artifacts to <a class="ulink" href="https://repository.apache.org/" target="_top">repository.apache.org</a> :</p><pre class="programlisting brush: shell">cd zest-java
+./gradlew -Dversion="<RELEASE-VERSION>" uploadArchives</pre><p>Close the staging Nexus repository by following the <a class="ulink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#close-stage" target="_top">Closing the staged repository</a> guide.</p></div><div class="section" title="Upload RC distributions"><div class="titlepage"><div><div><h5 class="title"><a id="_upload_rc_distributions"></a>Upload RC distributions</h5></div></div></div><p>Source and binary distributions, checksums and signatures must be uploaded to <a class="ulink" href="https://dist.apache.org/repos/dist/dev/zest/" target="_top">dist.apache.org/repos/dist/dev/zest</a>.
+This build created these in the <code class="literal">buid/distributions</code> directory, named <code class="literal">apache-zest-java-<RELEASE-VERSION>-[src|bin]*.*</code>.
+As this release still is a simple candidate, weâll rename them before upload to advertise this in their names.</p><pre class="programlisting brush: shell"># Source ZIP
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-src.zip" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.zip"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-src.zip.MD5" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.zip.MD5"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-src.zip.SHA-512" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.zip.SHA-512"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-src.zip.asc" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.zip.asc"
+# Source TAR.GZ
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-src.tgz" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.tgz"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-src.tgz.MD5" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.tgz.MD5"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-src.tgz.SHA-512" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.tgz.SHA-512"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-src.tgz.asc" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.tgz.asc"
+# Binary ZIP
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-bin.zip" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.zip"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-bin.zip.MD5" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.zip.MD5"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-bin.zip.SHA-512" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.zip.SHA-512"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-bin.zip.asc" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.zip.asc"
+# Binary TAR.GZ
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-bin.tgz" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.tgz"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-bin.tgz.MD5" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.tgz.MD5"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-bin.tgz.SHA-512" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.tgz.SHA-512"
+cp "zest-java/build/distributions/apache-zest-java-<RELEASE-VERSION>-bin.tgz.asc" "zest-dist/dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.tgz.asc"</pre><p>And then upload them:</p><pre class="programlisting brush: shell">cd zest-dist/dev/zest
svn add * --force
svn commit -m "zest: upload <RELEASE-VERSION> to dist/dev/zest"</pre></div></div><div class="section" title="Run the vote"><div class="titlepage"><div><div><h4 class="title"><a id="_run_the_vote"></a>Run the vote</h4></div></div></div><p>Send a "VOTE" to the <a class="ulink" href="mailto:dev@zest.apache.org" target="_top">developer mailing list</a> including links to release artifacts. A VOTE always contains two parts. Send an email to the developer mailing list with the subject line:</p><pre class="programlisting brush: text">[VOTE] Release Zest (Java Edition) version <RELEASE-VERSION></pre><p>Here is a sample template:</p><pre class="programlisting brush: text">Dear community,
@@ -153,35 +183,48 @@ Here is my vote:
+1 (binding)
Cheers</pre><p>After the vote is over, send a "RESULT" email to the list with the subject line:</p><pre class="programlisting brush: text">[RESULT][VOTE] Release Zest (Java Edition) version <RELEASE-VERSION></pre><p>Votes on whether a package is ready to be released use majority approvalâââi.e., at least three PMC members must vote affirmatively for release, and there must be more positive than negative votes.</p></div><div class="section" title="VOTE passes"><div class="titlepage"><div><div><h4 class="title"><a id="_vote_passes"></a>VOTE passes</h4></div></div></div><div class="section" title="Seal the release"><div class="titlepage"><div><div><h5 class="title"><a id="_seal_the_release"></a>Seal the release</h5></div></div></div><p>Create and sign the release git tag from the unsigned release candidate tag:</p><pre class="programlisting brush: shell">cd zest-java
-git tag -s <RELEASE-VERSION> <RELEASE-VERSION>-RC#</pre><p>Push all git changes:</p><pre class="programlisting brush: shell">cd zest-java
+git tag -s "<RELEASE-VERSION>" "<RELEASE-VERSION>-RC#"</pre><p>Push all git changes:</p><pre class="programlisting brush: shell">cd zest-java
git checkout master
git push origin master
git checkout develop
git push origin master
-git push origin --tags</pre></div><div class="section" title="Publish bits"><div class="titlepage"><div><div><h5 class="title"><a id="_publish_bits"></a>Publish bits</h5></div></div></div><p>Promote the staged Nexus repository so it gets synched to Maven Central by following the <a class="ulink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#promote" target="_top">Promoting a repo</a> guide.</p><p>Move the release distributions, checksums and signatures from <a class="ulink" href="https://dist.apache.org/repos/dist/dev/zest/" target="_top">dist.apache.org/repos/dist/dev/zest</a> to <a class="ulink" href="https://dist.apache.org/repos/dist/release/zest/" target="_top">dist.apache.org/repos/dist/release/zest</a></p><pre class="programlisting brush: shell">mv zest-dist-dev/apache-zest-java-<RELEASE-VERSION>-src* zest-dist-release/
-mv zest-dist-dev/apache-zest-java-<RELEASE-VERSION>-bin* zest-dist-release/
-cd zest-dist-dev
-svn add * --force
-svn commit -m "zest: removing <RELEASE-VERSION> from dist/dev/zest as the VOTE passed"
-cd ..
-cd zest-dist-release
-svn add * --force
-svn commit -m "zest: upload <RELEASE-VERSION> to dist/release/zest""</pre></div><div class="section" title="Wait 24 hours"><div class="titlepage"><div><div><h5 class="title"><a id="_wait_24_hours"></a>Wait 24 hours</h5></div></div></div><p>For mirrors to pick up the new bits.</p></div><div class="section" title="Prepare an announcement"><div class="titlepage"><div><div><h5 class="title"><a id="_prepare_an_announcement"></a>Prepare an announcement</h5></div></div></div><p>Coordinate a press release with <a class="ulink" href="mailto:press@apache.org" target="_top">press@apache.org</a>.</p><pre class="literallayout">TODO</pre><p>You can reuse the release-notes content from the <code class="literal">txt</code>/<code class="literal">adoc</code>/<code class="literal">md</code> files created earlier.</p><p>This annoucement will be used in a veriety of media like emails, websites etcâ¦
-Start with a text version and once satisfied produce at least a Markdown version for the website, see below.</p></div><div class="section" title="Update the Zest⢠website"><div class="titlepage"><div><div><h5 class="title"><a id="_update_the_zest_website"></a>Update the Zest⢠website</h5></div></div></div><p>Generate the documentation and javadoc minisite:</p><pre class="programlisting brush: shell">cd zest-java
-./gradlew -Dversion=<RELEASE-VERSION> archiveJavadocs manuals</pre><p>This will automatically put all files into the <code class="literal">zest-svn</code> website repository.</p><p>Create a new post on the Zest⢠website by creating a new Markdown file:</p><pre class="programlisting brush: shell">cd zest-svn
-touch site/src/_posts/YYYY-MM-DD-apache-zest-java-<RELEASE-VERSION>.md
-open !$</pre><p>You can reuse the Markdown formatted announcement content.</p><p>Add the new released version in <code class="literal">zest-svn/site/content/java/versions.json</code> below the <code class="literal">latest</code> entry:</p><pre class="programlisting brush: json">{
+git push origin --tags</pre></div><div class="section" title="Publish bits"><div class="titlepage"><div><div><h5 class="title"><a id="_publish_bits"></a>Publish bits</h5></div></div></div><p>Promote the staged Nexus repository so it gets synched to Maven Central by following the <a class="ulink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#promote" target="_top">Promoting a repo</a> guide.</p><p>Move the release distributions, checksums and signatures from <a class="ulink" href="https://dist.apache.org/repos/dist/dev/zest/" target="_top">zest-dist/dev/zest</a> to <a class="ulink" href="https://dist.apache.org/repos/dist/release/zest/" target="_top">zest-dist/release/zest</a>:</p><pre class="programlisting brush: shell">cd zest-dist
+# Source ZIP
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.zip" "release/zest/apache-zest-java-<RELEASE-VERSION>-src.zip"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.zip.MD5" "release/zest/apache-zest-java-<RELEASE-VERSION>-src.zip.MD5"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.zip.SHA-512" "release/zest/apache-zest-java-<RELEASE-VERSION>-src.zip.SHA-512"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.zip.asc" "release/zest/apache-zest-java-<RELEASE-VERSION>-src.zip.asc"
+# Source TAR.GZ
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.tgz" "release/zest/apache-zest-java-<RELEASE-VERSION>-src.tgz"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.tgz.MD5" "release/zest/apache-zest-java-<RELEASE-VERSION>-src.tgz.MD5"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.tgz.SHA-512" "release/zest/apache-zest-java-<RELEASE-VERSION>-src.tgz.SHA-512"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-src.tgz.asc" "release/zest/apache-zest-java-<RELEASE-VERSION>-src.tgz.asc"
+# Binary ZIP
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.zip" "release/zest/apache-zest-java-<RELEASE-VERSION>-bin.zip"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.zip.MD5" "release/zest/apache-zest-java-<RELEASE-VERSION>-bin.zip.MD5"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.zip.SHA-512" "release/zest/apache-zest-java-<RELEASE-VERSION>-bin.zip.SHA-512"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.zip.asc" "release/zest/apache-zest-java-<RELEASE-VERSION>-bin.zip.asc"
+# Binary TAR.GZ
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.tgz" "release/zest/apache-zest-java-<RELEASE-VERSION>-bin.tgz"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.tgz.MD5" "release/zest/apache-zest-java-<RELEASE-VERSION>-bin.tgz.MD5"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.tgz.SHA-512" "release/zest/apache-zest-java-<RELEASE-VERSION>-bin.tgz.SHA-512"
+svn move "dev/zest/apache-zest-java-<RELEASE-VERSION>-RC#-bin.tgz.asc" "release/zest/apache-zest-java-<RELEASE-VERSION>-bin.tgz.asc"</pre><p>And upload them:</p><pre class="programlisting brush: shell">cd zest-dist
+svn commit -m "zest: <RELEASE-VERSION>-RC# vote passed, promoted as <RELEASE-VERSION> release"</pre></div><div class="section" title="Wait 24 hours"><div class="titlepage"><div><div><h5 class="title"><a id="_wait_24_hours"></a>Wait 24 hours</h5></div></div></div><p>For mirrors to pick up the new bits.</p></div><div class="section" title="Prepare an announcement"><div class="titlepage"><div><div><h5 class="title"><a id="_prepare_an_announcement"></a>Prepare an announcement</h5></div></div></div><p>Coordinate a press release with <a class="ulink" href="mailto:press@apache.org" target="_top">press@apache.org</a>.</p><pre class="literallayout">TODO</pre><p>You can reuse the release-notes content from the <code class="literal">txt</code>/<code class="literal">adoc</code>/<code class="literal">md</code> files created earlier.</p><p>This annoucement will be used in a variety of media like emails, websites etcâ¦
+Start with a text version and once satisfied create at least a Markdown version for the website, see below.</p></div><div class="section" title="Update the Zest⢠website"><div class="titlepage"><div><div><h5 class="title"><a id="_update_the_zest_website"></a>Update the Zest⢠website</h5></div></div></div><p>Generate the documentation and javadoc minisite:</p><pre class="programlisting brush: shell">cd zest-java
+./gradlew -Dversion="<RELEASE-VERSION>" archiveJavadocs manuals</pre><p>This will automatically put all files into the <code class="literal">zest-web</code> website repository.</p><p>Create a new post on the Zest⢠website by creating a new Markdown file:</p><pre class="programlisting brush: shell">cd zest-web
+touch "site/src/_posts/YYYY-MM-DD-apache-zest-java-<RELEASE-VERSION>.md"
+open !$</pre><p>You can reuse the Markdown formatted announcement content.</p><p>Add the new released version in <code class="literal">zest-web/site/content/java/versions.json</code> below the <code class="literal">latest</code> entry:</p><pre class="programlisting brush: js">{
"develop": "develop",
"latest": "latest",
"<RELEASE-VERSION>", "<RELEASE-VERSION>",
"2.0": "2.0",
"<=1.4.x": "1.4"
-}</pre><p>Finally, edit <code class="literal">zest-svn/site/src/_data/releases.yml</code> with the new release data.
-Upmost is the latest:</p><pre class="programlisting brush: yaml">- version: <RELEASE-VERSION>
+}</pre><p>Finally, edit <code class="literal">zest-web/site/src/_data/releases.yml</code> with the new release data.
+Upmost is the latest:</p><pre class="programlisting brush: text">- version: <RELEASE-VERSION>
announcement: YYYY/MM/DD/apache-zest-java-<RELEASE-VERSION>
signer: John Doe
- pgpId: FB751943</pre><p>You can live-preview your changes to the Zest⢠website:</p><pre class="programlisting brush: shell">cd zest-svn
-jekyll serve</pre><p>Once you are satisfied with the changes, build the production website:</p><pre class="programlisting brush: shell">cd zest-svn
+ pgpId: FB751943</pre><p>You can run the Zest⢠website locally:</p><pre class="programlisting brush: shell">cd zest-web
+jekyll serve</pre><p>Open <a class="ulink" href="http://127.0.0.1:4000/" target="_top">http://127.0.0.1:4000/</a> to live-preview your changes.</p><p>Once you are satisfied with the changes, build the production website:</p><pre class="programlisting brush: shell">cd zest-web
jekyll build</pre><p>And publish it:</p><pre class="programlisting brush: shell">svn add * --force
svn commit -m "zest: update website"</pre></div><div class="section" title="Register the release"><div class="titlepage"><div><div><h5 class="title"><a id="_register_the_release"></a>Register the release</h5></div></div></div><p>Register the new release at <a class="ulink" href="https://reporter.apache.org/" target="_top">reporter.apache.org</a></p></div><div class="section" title="Announce"><div class="titlepage"><div><div><h5 class="title"><a id="_announce"></a>Announce</h5></div></div></div><p>Finally, send an announcement to <a class="ulink" href="mailto:dev@zest.apache.org" target="_top">dev@</a> and <a class="ulink" href="mailto:users@zest.apache.org" target="_top">users@</a> mailing lists. Email announcements should have the subject line:</p><pre class="programlisting brush: text">[ANNOUNCE] Released Zest (Java Edition) version <RELEASE-VERSION></pre><p>The announcement email should contains the release-notes as text, remember they are in the <code class="literal">apach
e-zest-java-<RELEASE-VERSION>-release-notes.txt</code> file you created earlier.</p></div></div><div class="section" title="VOTE fails"><div class="titlepage"><div><div><h4 class="title"><a id="_vote_fails"></a>VOTE fails</h4></div></div></div><div class="section" title="Record failure"><div class="titlepage"><div><div><h5 class="title"><a id="_record_failure"></a>Record failure</h5></div></div></div><p>We keep the release candidate git history.
It can be useful for reviewers to have access to it.
@@ -190,10 +233,10 @@ git checkout master
git push origin master
git checkout develop
git push origin master
-git push origin --tags</pre></div><div class="section" title="Drop RC artifacts and distributions"><div class="titlepage"><div><div><h5 class="title"><a id="_drop_rc_artifacts_and_distributions"></a>Drop RC artifacts and distributions</h5></div></div></div><p>Drop the Nexus staging repository by following the <a class="ulink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#drop" target="_top">Dropping a repo</a> guide.</p><p>Drop distributions, checksums and signatures from <a class="ulink" href="https://dist.apache.org/repos/dist/dev/zest/" target="_top">dist.apache.org/repos/dist/dev/zest</a></p><pre class="programlisting brush: shell">cd zest-dist-dev/
-rm "*<RELEASE-VERSION>*.*"
+git push origin --tags</pre></div><div class="section" title="Drop RC artifacts and distributions"><div class="titlepage"><div><div><h5 class="title"><a id="_drop_rc_artifacts_and_distributions"></a>Drop RC artifacts and distributions</h5></div></div></div><p>Drop the Nexus staging repository by following the <a class="ulink" href="https://www.apache.org/dev/publishing-maven-artifacts.html#drop" target="_top">Dropping a repo</a> guide.</p><p>Drop distributions, checksums and signatures from <a class="ulink" href="https://dist.apache.org/repos/dist/dev/zest/" target="_top">zest-dist/dev/zest</a></p><pre class="programlisting brush: shell">cd zest-dist/dev/zest/
+rm "*<RELEASE-VERSION>-RC#*.*"
svn add * --force
-svn commit -m "zest: dropping <RELEASE-VERSION> from dist/dev/zest as the vote failed"</pre></div><div class="section" title="Start over"><div class="titlepage"><div><div><h5 class="title"><a id="_start_over"></a>Start over</h5></div></div></div><p>If a new RC is to be created, restart the process as described above.</p></div></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common" class="footer"><p>
+svn commit -m "zest: dropping <RELEASE-VERSION>-RC# from dist/dev/zest as the vote failed"</pre></div><div class="section" title="Start over"><div class="titlepage"><div><div><h5 class="title"><a id="_start_over"></a>Start over</h5></div></div></div><p>If a new RC is to be created, restart the process as described above.</p></div></div></div><div xmlns="" xmlns:exsl="http://exslt.org/common" class="footer"><p>
Copyright © 2015 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/" target="_blank">Apache License, Version 2.0</a>.
<br /><small>
Apache Zest, Zest, Apache, the Apache feather logo, and the Apache Zest project logo are trademarks of The Apache Software Foundation.<br />