You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apex.apache.org by th...@apache.org on 2016/02/22 07:09:30 UTC

[1/2] incubator-apex-site git commit: APEXCORE-215 #comment Added Apache Apex release candidate verification guidelines

Repository: incubator-apex-site
Updated Branches:
  refs/heads/master 6849dde67 -> 86ca20b40


APEXCORE-215 #comment Added Apache Apex release candidate verification guidelines


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/34e144be
Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/34e144be
Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/34e144be

Branch: refs/heads/master
Commit: 34e144bed9ec6bbcd4d4db7aee887c67b8fc8b40
Parents: 8c560b1
Author: Sandeep Deshmukh <sa...@datatorrent.com>
Authored: Fri Jan 29 20:42:25 2016 +0530
Committer: Sandeep Deshmukh <sa...@datatorrent.com>
Committed: Mon Feb 22 09:45:37 2016 +0530

----------------------------------------------------------------------
 src/md/community.md         |   2 +
 src/md/verification.md      | 112 +++++++++++++++++++++++++++++++++++++++
 src/pages/verification.html |   9 ++++
 3 files changed, 123 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/34e144be/src/md/community.md
----------------------------------------------------------------------
diff --git a/src/md/community.md b/src/md/community.md
index f059bae..60aec91 100644
--- a/src/md/community.md
+++ b/src/md/community.md
@@ -22,6 +22,8 @@ The Apex Project is made up of two repositories:
 
 **To learn more about the release process for Apex, [check out the release guidelines](/release.html).**
 
+**To learn more about the release candidate verification for Apex, [check out the verification guidelines](/verification.html).**
+
 ## Issue Tracking
 
 - [Apex Core JIRA](https://issues.apache.org/jira/browse/APEXCORE/)

http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/34e144be/src/md/verification.md
----------------------------------------------------------------------
diff --git a/src/md/verification.md b/src/md/verification.md
new file mode 100644
index 0000000..4a967ba
--- /dev/null
+++ b/src/md/verification.md
@@ -0,0 +1,112 @@
+# How to verify Apache Apex (incubating) 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.
+```bash
+wget https://dist.apache.org/repos/dist/release/incubator/apex/KEYS
+gpg --import KEYS
+gpg --fingerprint D920A98C
+```
+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.
+```bash
+gpg --gen-key
+```
+Please provide 4096 as keysize while generating the key.
+
+
+## File integrity check
+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.
+
+```bash
+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.
+```bash
+APEX_RELEASE_CANDIDATE=apex-3.3.0-incubating
+```
+
+Verify integrity of tar.gz file:
+```bash
+gpg --verify $APEX_RELEASE_CANDIDATE-source-release.tar.gz.asc
+md5sum --check $APEX_RELEASE_CANDIDATE-source-release.tar.gz.md5
+sha512sum --check $APEX_RELEASE_CANDIDATE-source-release.tar.gz.sha
+```
+
+Verify integrity of .zip file:
+```bash
+gpg --verify $APEX_RELEASE_CANDIDATE-source-release.zip.asc
+md5sum --check $APEX_RELEASE_CANDIDATE-source-release.zip.md5
+sha512sum --check $APEX_RELEASE_CANDIDATE-source-release.zip.sha
+```
+
+## Source code verification
+You can extract source either using .tar.gz file or .zip file.
+
+### Using .tar.gz source
+Extract source using .tar.gz:
+```bash
+tar -zxvf $APEX_RELEASE_CANDIDATE-source-release.tar.gz
+```
+### Using .zip source
+```bash
+unzip $APEX_RELEASE_CANDIDATE-source-release.zip
+```
+
+Any of the two commands above will create a directory named after *apex release candidate*.
+
+Change directory:
+```bash
+cd $APEX_RELEASE_CANDIDATE
+```
+
+### Miscellaneous checks: Part I (Pre Compilation)
+1. 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.
+2. 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
+```
+Please make sure no binary extension is listed here. Likely candidates are .jar files.  Additionally, for Malhar, demo package files, i.e. .apa files.
+
+### Check for compilation, license headers, etc.
+
+For Apex:
+```bash
+mvn clean apache-rat:check verify -Dlicense.skip=false install
+```
+For Malhar:
+```bash
+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.
+```bash
+mvn verify -Papache-release -DskipTests
+```
+
+## Launch demos
+
+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.
+
+```bash
+engine/src/main/scripts/dtcli 
+```
+You will get dtcli prompt, where demos can be launched.
+```bash
+dt> launch <demo-apk-file>
+```
+Demo apk files are typically in incubating-apex-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.

http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/34e144be/src/pages/verification.html
----------------------------------------------------------------------
diff --git a/src/pages/verification.html b/src/pages/verification.html
new file mode 100644
index 0000000..dd0a9fe
--- /dev/null
+++ b/src/pages/verification.html
@@ -0,0 +1,9 @@
+{{> header}}
+
+<div class="container">
+  
+  {{> verification}}
+
+</div>
+
+{{> footer}}


[2/2] incubator-apex-site git commit: Merge branch 'APEXCORE-215.build-verification-steps' of https://github.com/sandeepdeshmukh/incubator-apex-site

Posted by th...@apache.org.
Merge branch 'APEXCORE-215.build-verification-steps' of https://github.com/sandeepdeshmukh/incubator-apex-site


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/86ca20b4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/86ca20b4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/86ca20b4

Branch: refs/heads/master
Commit: 86ca20b40f53892330a2b86c821b90e12fc9f664
Parents: 6849dde 34e144b
Author: Thomas Weise <th...@datatorrent.com>
Authored: Sun Feb 21 22:04:45 2016 -0800
Committer: Thomas Weise <th...@datatorrent.com>
Committed: Sun Feb 21 22:04:45 2016 -0800

----------------------------------------------------------------------
 src/md/community.md         |   4 +-
 src/md/verification.md      | 112 +++++++++++++++++++++++++++++++++++++++
 src/pages/verification.html |   9 ++++
 3 files changed, 124 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/86ca20b4/src/md/community.md
----------------------------------------------------------------------
diff --cc src/md/community.md
index f82c0a8,60aec91..8ce4486
--- a/src/md/community.md
+++ b/src/md/community.md
@@@ -30,7 -31,19 +32,7 @@@ The Apex Project is made up of two repo
  
  ## Meetup Groups
  
 -To see upcoming meetup events, please visit [announcements page](/announcements.html).
 +Full list of Apache Apex meetup groups is available at [Apache Apex Meetup Groups](http://apache-apex.meetup.com/)
  
 -- [Austin Chapter]( http://www.meetup.com/Apache-Apex-Austin-Chapter/)
 -- [Bay Area Chapter](http://www.meetup.com/Apex-Bay-Area-Chapter)
 -- [Bengaluru Chapter](http://www.meetup.com/Apache-Apex-incubating-Bengaluru-Meetup)
 -- [Chicago Chapter](http://www.meetup.com/Apache-Apex-Meetup-Chicago-Chapter)
 -- [Columbus Chapter](http://www.meetup.com/Apex-Meetup-Columbus)
 -- [Dallas Chapter]( http://www.meetup.com/Apache-Apex-Dallas-Chapter/)
 -- [Denver Chapter]( http://www.meetup.com/Apache-Apex-Denver-Chapter/)
 -- [El Segundo Chapter]( http://www.meetup.com/Apache-Apex-El-Segundo-Chapter/)
 -- [Houston Chapter](http://www.meetup.com/Apex-Meetup-Houston)
 -- [New York Chapter](http://www.meetup.com/Apache-Apex-New-York-Chapter)
 -- [Phoenix Chapter](http://www.meetup.com/Apache-Apex-Phoenix-Chapter/)
 -- [Richmond VA Chapter](http://www.meetup.com/Apache-Apex-Richmond-VA-Area-Chapter/)
 -- [Pune Chapter](http://www.meetup.com/Apache-Apex-incubating-Meetup-Pune)
  
- To see upcoming meetup events, please visit [announcements page](/announcements.html).
++To see upcoming meetup events, please visit [announcements page](/announcements.html).