Repository: incubator-apex-site Updated Branches: refs/heads/master 0419ae5eb -> d85f552e5
Updates in verification page to remove incubator related part. 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/d85f552e Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/d85f552e Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/d85f552e Branch: refs/heads/master Commit: d85f552e516bf757b71a3d7d198ba430c55fc499 Parents: 0419ae5 Author: Sandeep Deshmukh <[email protected]> Authored: Mon May 23 11:54:13 2016 +0530 Committer: Sandeep Deshmukh <[email protected]> Committed: Mon May 23 12:19:27 2016 +0530 ---------------------------------------------------------------------- src/md/verification.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/d85f552e/src/md/verification.md ---------------------------------------------------------------------- diff --git a/src/md/verification.md b/src/md/verification.md index fffe2a3..410346f 100644 --- a/src/md/verification.md +++ b/src/md/verification.md @@ -1,16 +1,18 @@ # How to verify Apache Apex release candidate builds ## Prerequisites -1. Download the KEYS file and import it. Verify that the key just imported is correct. -This is one time activity. +Download the KEYS file and import it. Verify that the key just imported is correct. ```bash wget https://dist.apache.org/repos/dist/release/incubator/apex/KEYS gpg --import KEYS -gpg --fingerprint D920A98C +gpg --fingerprint <key-id> ``` +The <key-id> of the release manager can be found out in the *PGP key* 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. + More about key verification at [http://www.apache.org/info/verification.html](http://www.apache.org/info/verification.html) -2. You can also created your own key which is required if you would like to sign the build. This step is optional. + +You can also create your own key which is required if you would like to sign the build. This step is optional. ```bash gpg --gen-key ``` @@ -25,9 +27,9 @@ wget -r -np -nd <staging-area-link>/ ``` Note the link should end with "/". -Define the apex release candidate variable. We will set it up *apex-3.3.0-incubating* as an example. +Define the apex release candidate variable. We will set it up *apex-3.4.0* as an example. ```bash -APEX_RELEASE_CANDIDATE=apex-3.3.0-incubating +APEX_RELEASE_CANDIDATE=apex-3.4.0 ``` Verify integrity of tar.gz file: @@ -65,9 +67,11 @@ cd $APEX_RELEASE_CANDIDATE ``` ### Miscellaneous checks: Part I (Pre Compilation) -1. Existence of DISCLAIMER, LICENSE, NOTICE, README.md and CHANGELOG.md files. +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. -2. No unexpected binary files in the sources. + + +No unexpected binary files in the sources. The extracted directory should not contain any binary. Need to test this before compiling the source code. ```bash find . -type f -name '*.*' | sed 's|.*\.||' | sort -u @@ -86,7 +90,7 @@ mvn clean apache-rat:check verify -Dlicense.skip=false -Pall-modules install ``` Jars should be installed in your maven repository, typically in *~/.m2/repository/org/apache/apex/* directory -Following step is optional and needs prerequisite 2 given above. +Following step is optional and needs the key generated by you as in prerequisite section given above. ```bash mvn verify -Papache-release -DskipTests ``` @@ -95,18 +99,18 @@ mvn verify -Papache-release -DskipTests For verification of Apex build, check backward compatibility with respect to Malhar. Locally update *apex.core.version* in Malhar to point to *to-be released* version of apex-core and recompile Malhar. -Launch few demos to make sure everything is working fine using *dtcli* 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. +Launch few demos to make sure everything is working fine using *apex* 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. ```bash -engine/src/main/scripts/dtcli +engine/src/main/scripts/apex ``` -You will get dtcli prompt, where demos can be launched. +You will get apex prompt, where demos can be launched. ```bash -dt> launch <demo-apa-file> +apex> launch <demo-apa-file> ``` -Demo apa files are typically in incubating-apex-malhar/demos directory. +Demo apa files are typically in malhar/demos directory. ## Miscellaneous checks: Part II (Post compilation) -1. 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 *~/.m2/repository/org/apache/apex/* directory. +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 *~/.m2/repository/org/apache/apex/* directory on your local machine.
