Repository: incubator-apex-site Updated Branches: refs/heads/asf-site a520aa203 -> 29cc06968
from d85f552e516bf757b71a3d7d198ba430c55fc499 Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/commit/29cc0696 Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/29cc0696 Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/29cc0696 Branch: refs/heads/asf-site Commit: 29cc06968adecf34eb3c77d4337bce95736b4ce5 Parents: a520aa2 Author: Thomas Weise <[email protected]> Authored: Mon May 23 10:53:19 2016 -0700 Committer: Thomas Weise <[email protected]> Committed: Mon May 23 10:53:19 2016 -0700 ---------------------------------------------------------------------- content/verification.html | 47 ++++++++++++++++++------------------------ 1 file changed, 20 insertions(+), 27 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/29cc0696/content/verification.html ---------------------------------------------------------------------- diff --git a/content/verification.html b/content/verification.html index 3c9a9ba..1521820 100644 --- a/content/verification.html +++ b/content/verification.html @@ -77,28 +77,24 @@ <h1 id="how-to-verify-apache-apex-release-candidate-builds">How to verify Apache Apex release candidate builds</h1> <h2 id="prerequisites">Prerequisites</h2> -<ol> -<li><p>Download the KEYS file and import it. Verify that the key just imported is correct. -This is one time activity.</p> +<p>Download the KEYS file and import it. Verify that the key just imported is correct.</p> <pre><code class="lang-bash">wget https://dist.apache.org/repos/dist/release/incubator/apex/KEYS gpg --import KEYS -gpg --fingerprint D920A98C +gpg --fingerprint <key-id> </code></pre> +<p>The <key-id> of the release manager can be found out in the <em>PGP key</em> link in the mail. It would be alphanumric number like D920A98Cbb. The above step can be skipped if you have already imported key of the current release manager.</p> <p>More about key verification at <a href="http://www.apache.org/info/verification.html";>http://www.apache.org/info/verification.html</a></p> -</li> -<li><p>You can also created your own key which is required if you would like to sign the build. This step is optional.</p> +<p>You can also create your own key which is required if you would like to sign the build. This step is optional.</p> <pre><code class="lang-bash">gpg --gen-key </code></pre> <p>Please provide 4096 as keysize while generating the key.</p> -</li> -</ol> <h2 id="file-integrity-check">File integrity check</h2> <p>Download all files present in staging directory of the RC build. Staging directory link is shared in VOTE thread of the release candidate. It is recommended that these files are downloaded in a clean directory.</p> <pre><code class="lang-bash">wget -r -np -nd <staging-area-link>/ </code></pre> <p>Note the link should end with "/".</p> -<p>Define the apex release candidate variable. We will set it up <em>apex-3.3.0-incubating</em> as an example.</p> -<pre><code class="lang-bash">APEX_RELEASE_CANDIDATE=apex-3.3.0-incubating +<p>Define the apex release candidate variable. We will set it up <em>apex-3.4.0</em> as an example.</p> +<pre><code class="lang-bash">APEX_RELEASE_CANDIDATE=apex-3.4.0 </code></pre> <p>Verify integrity of tar.gz file:</p> <pre><code class="lang-bash">gpg --verify $APEX_RELEASE_CANDIDATE-source-release.tar.gz.asc @@ -124,14 +120,13 @@ sha512sum --check $APEX_RELEASE_CANDIDATE-source-release.zip.sha <pre><code class="lang-bash">cd $APEX_RELEASE_CANDIDATE </code></pre> <h3 id="miscellaneous-checks-part-i-pre-compilation-">Miscellaneous checks: Part I (Pre Compilation)</h3> -<ol> -<li>Existence of DISCLAIMER, LICENSE, NOTICE, README.md and CHANGELOG.md files. -Please make sure these files are present in the parent folder after extracting the zip or tar. The CHANGELOG.md file should contain change log for the current release.</li> -<li>No unexpected binary files in the sources. -The extracted directory should not contain any binary. Need to test this before compiling the source code.<pre><code class="lang-bash">find . -type f -name '*.*' | sed 's|.*\.||' | sort -u +<p>Existence of LICENSE, NOTICE, README.md and CHANGELOG.md files. +Please make sure these files are present in the parent folder after extracting the zip or tar. The CHANGELOG.md file should contain change log for the current release.</p> +<p>No unexpected binary files in the sources. +The extracted directory should not contain any binary. Need to test this before compiling the source code.</p> +<pre><code class="lang-bash">find . -type f -name '*.*' | sed 's|.*\.||' | sort -u </code></pre> -Please make sure no binary extension is listed here. Likely candidates are .jar files. Additionally, for Malhar, demo package files, i.e. .apa files.</li> -</ol> +<p>Please make sure no binary extension is listed here. Likely candidates are .jar files. Additionally, for Malhar, demo package files, i.e. .apa files.</p> <h3 id="check-for-compilation-license-headers-etc-">Check for compilation, license headers, etc.</h3> <p>For Apex:</p> <pre><code class="lang-bash">mvn clean apache-rat:check verify -Dlicense.skip=false install @@ -140,23 +135,21 @@ Please make sure no binary extension is listed here. Likely candidates are .jar <pre><code class="lang-bash">mvn clean apache-rat:check verify -Dlicense.skip=false -Pall-modules install </code></pre> <p>Jars should be installed in your maven repository, typically in <em>~/.m2/repository/org/apache/apex/</em> directory</p> -<p>Following step is optional and needs prerequisite 2 given above.</p> +<p>Following step is optional and needs the key generated by you as in prerequisite section given above.</p> <pre><code class="lang-bash">mvn verify -Papache-release -DskipTests </code></pre> <h2 id="launch-demos">Launch demos</h2> <p>For verification of Apex build, check backward compatibility with respect to Malhar. Locally update <em>apex.core.version</em> in Malhar to point to <em>to-be released</em> version of apex-core and recompile Malhar.</p> -<p>Launch few demos to make sure everything is working fine using <em>dtcli</em> utitlity. The dtcli script is present at <apex-core-folder>/engine/src/main/scripts/dtcli . If apex-core is being verified, then simply use engine/src/main/scripts/dtcli to launch the script. Otherwise, prefix it with apex-core folder path.</p> -<pre><code class="lang-bash">engine/src/main/scripts/dtcli +<p>Launch few demos to make sure everything is working fine using <em>apex</em> utitlity. The apex script is present at <apex-core-folder>/engine/src/main/scripts/apex . If apex-core is being verified, then simply use engine/src/main/scripts/apex to launch the script. Otherwise, prefix it with apex-core folder path.</p> +<pre><code class="lang-bash">engine/src/main/scripts/apex </code></pre> -<p>You will get dtcli prompt, where demos can be launched.</p> -<pre><code class="lang-bash">dt> launch <demo-apa-file> +<p>You will get apex prompt, where demos can be launched.</p> +<pre><code class="lang-bash">apex> launch <demo-apa-file> </code></pre> -<p>Demo apa files are typically in incubating-apex-malhar/demos directory.</p> +<p>Demo apa files are typically in malhar/demos directory.</p> <h2 id="miscellaneous-checks-part-ii-post-compilation-">Miscellaneous checks: Part II (Post compilation)</h2> -<ol> -<li>Correct artifact names -All the apex artifacts generated in local maven build directory should contain classs jar, sources jars, javadocs jar. All the artifacts are under <em>~/.m2/repository/org/apache/apex/</em> directory.</li> -</ol> +<p>Correct artifact names: +All the apex artifacts generated in local maven build directory should contain classs jar, sources jars, javadocs jar. All the artifacts are under <em>~/.m2/repository/org/apache/apex/</em> directory on your local machine.</p> </div>
