Repository: commons-crypto Updated Branches: refs/heads/master d4c6b9fb6 -> 3f835c2f5
CRYPTO-45: Document how to build Commons Crypto Project: http://git-wip-us.apache.org/repos/asf/commons-crypto/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-crypto/commit/3f835c2f Tree: http://git-wip-us.apache.org/repos/asf/commons-crypto/tree/3f835c2f Diff: http://git-wip-us.apache.org/repos/asf/commons-crypto/diff/3f835c2f Branch: refs/heads/master Commit: 3f835c2f567c3ecb086b6ca0db84302c2b1fc63d Parents: d4c6b9f Author: dianfu <dia...@apache.org> Authored: Thu May 5 09:59:30 2016 +0800 Committer: dianfu <dia...@apache.org> Committed: Thu May 5 09:59:30 2016 +0800 ---------------------------------------------------------------------- BUILDING.txt | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ pom.xml | 9 +++++++ 2 files changed, 89 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/3f835c2f/BUILDING.txt ---------------------------------------------------------------------- diff --git a/BUILDING.txt b/BUILDING.txt new file mode 100644 index 0000000..e7e170b --- /dev/null +++ b/BUILDING.txt @@ -0,0 +1,80 @@ +Build instructions for Apache Commons Crypto + +---------------------------------------------------------------------------------- +Requirements: + +* Unix System (Linux or Mac) +* JDK 1.6 or above (environment variable JAVA_HOME must be set) +* Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy + Files (if running unit tests) +* Maven 3.0 or above +* Make +* OpenSSL devel 1.0.1c or above + +---------------------------------------------------------------------------------- +Install JCE Unlimited Strength Jurisdiction Policy Files: + +Download the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files from Oracle: + +For JDK 1.6: http://www.oracle.com/technetwork/java/javase/downloads/jce-6-download-429243.html +For JDK 1.7: http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html +For JDK 1.8: http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html + +Install JCE Unlimited Strength Jurisdiction Policy Files to JDK: + +Copy downloaded local_policy.jar and US_export_policy.jar to <java-home>/jre/lib/security/ + +---------------------------------------------------------------------------------- +Verify OpenSSL version: + +Check OpenSSL version: + + $ openssl version + +If it is not 1.0.1c or above, upgrade OpenSSL version to 1.0.1c or above: + +Upgrade OpenSSL in Linux: + +You can follow your OS distribution instructions to upgrade OpenSSL to a proper version. + +Upgrade OpenSSL in Mac: + + $ brew install homebrew/versions/openssl101 + $ brew link openssl --force + +---------------------------------------------------------------------------------- +Maven build goals: + +* Clean : mvn clean +* Compile : mvn compile +* Run tests : mvn test +* Create JAR : mvn package +* Run findbugs : mvn compile -Pfindbugs +* Run checkstyle : mvn compile checkstyle:checkstyle +* Install JAR in M2 cache : mvn install +* Deploy JAR to Maven repo : mvn deploy +* Run Rat : mvn apache-rat:check +* Build javadocs : mvn javadoc:javadoc +* Change version : mvn versions:set -DnewVersion=NEWVERSION + +---------------------------------------------------------------------------------- +Importing projects to eclipse + +Generate eclipse project files. + + $ mvn eclipse:eclipse -DskipTests + +At last, import to eclipse by specifying the root directory of the project via +[File] > [Import] > [Existing Projects into Workspace]. + +---------------------------------------------------------------------------------- +Building distributions: + +Create binary distribution: + + $ mvn package -DskipTests + +Create a local staging version of the website (in /tmp/crypto-site): + + $ mvn clean site; mvn site:stage -DstagingDirectory=/tmp/crypto-site + http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/3f835c2f/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index c5b7541..72e58bd 100644 --- a/pom.xml +++ b/pom.xml @@ -335,6 +335,15 @@ Features <groupId>org.apache.rat</groupId> <artifactId>apache-rat-plugin</artifactId> <version>${commons.rat.version}</version> + <configuration> + <excludes> + <exclude>.gitattributes</exclude> + <exclude>.gitignore</exclude> + <exclude>.git/**</exclude> + <exclude>.idea/**</exclude> + <exclude>**/build/**</exclude> + </excludes> + </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId>
