[GOBBLIN-355] Update README and release.gradle to include distribution build instruction
Project: http://git-wip-us.apache.org/repos/asf/incubator-gobblin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-gobblin/commit/433efffe Tree: http://git-wip-us.apache.org/repos/asf/incubator-gobblin/tree/433efffe Diff: http://git-wip-us.apache.org/repos/asf/incubator-gobblin/diff/433efffe Branch: refs/heads/0.12.0 Commit: 433efffe6eccd832e36e6219422057e2cedd04e7 Parents: c9b5ab3 Author: Abhishek Tiwari <[email protected]> Authored: Fri Mar 23 03:00:22 2018 -0700 Committer: Abhishek Tiwari <[email protected]> Committed: Fri Mar 23 03:09:49 2018 -0700 ---------------------------------------------------------------------- README.md | 37 ++++++++++++++++++++++++++++++++++++- gradle/scripts/release.gradle | 6 ++---- 2 files changed, 38 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/433efffe/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index b513c70..e99fe8d 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,47 @@ Apache Gobblin is a universal data ingestion framework for extracting, transforming, and loading large volume of data from a variety of data sources, e.g., databases, rest APIs, FTP/SFTP servers, filers, etc., onto Hadoop. Apache Gobblin handles the common routine tasks required for all data ingestion ETLs, including job/task scheduling, task partitioning, error handling, state management, data quality checking, data publishing, etc. Gobblin ingests data from different data sources in the same execution framework, and manages metadata of different sources all in one place. This, combined with other features such as auto scalability, fault tolerance, data quality assurance, extensibility, and the ability of handling data model evolution, makes Gobblin an easy-to-use, self-serving, and efficient data ingestion framework. +# Requirements +* Java >= 1.8 +* gradle-wrapper.jar version 2.13 + +If building the distribution with tests turned on: +* Maven version 3.5.3 + +# Instructions to download gradle wrapper +Run the following command for downloading the gradle-wrapper.jar from Gobblin git repository to gradle/wrapper directory. + +wget --no-check-certificate -P gradle/wrapper https://github.com/apache/incubator-gobblin/raw/0.12.0/gradle/wrapper/gradle-wrapper.jar +(or) +curl --insecure -L https://github.com/apache/incubator-gobblin/raw/0.12.0/gradle/wrapper/gradle-wrapper.jar > gradle/wrapper/gradle-wrapper.jar + +Alternatively, you can download it manually from: +https://github.com/apache/incubator-gobblin/blob/0.12.0/gradle/wrapper/gradle-wrapper.jar + +Make sure that you download it to gradle/wrapper directory. + +# Instructions to run Apache RAT (Release Audit Tool) +1. Extract the archive file to your local directory. +2. Download gradle-wrapper.jar (version 2.13) and place it in the gradle/wrapper folder. See 'Instructions to download gradle wrapper' above. +3. Run `./gradlew rat`. Report will be generated under build/rat/rat-report.html + +# Instructions to build the distribution +1. Extract the archive file to your local directory. +2. Download gradle-wrapper.jar (version 2.13) and place it in the gradle/wrapper folder. See 'Instructions to download gradle wrapper' above. +3. Skip tests and build the distribution: +Run `./gradlew build -x findbugsMain -x test -x rat -x checkstyleMain` +The distribution will be created in build/gobblin-distribution/libs directory. +(or) +3. Run tests and build the distribution (requires Maven): +Run `./gradlew build` +The distribution will be created in build/gobblin-distribution/libs directory. + # Quick Links * Documentation: Check out the [Gobblin documentation](http://gobblin.readthedocs.org/en/latest/) for a complete description of Gobblin's features * Powered By: Check out the [list of companies](http://gobblin.readthedocs.io/en/latest/Powered-By/) known to use Gobblin * Architecture: The [Gobblin Architecture](http://gobblin.readthedocs.io/en/latest/Gobblin-Architecture/) page has a full explanation of Gobblin's architecture * Getting Started with Gobblin: Refer to the [Getting Started Guide](http://gobblin.readthedocs.org/en/latest/Getting-Started/) on how to get started with Gobblin - * Building Gobblin: Refer to the page [Building Gobblin](http://gobblin.readthedocs.io/en/latest/user-guide/Building-Gobblin/) for directions on how to build Gobblin + * Building Gobblin (from master branch): Refer to the page [Building Gobblin](http://gobblin.readthedocs.io/en/latest/user-guide/Building-Gobblin/) for directions on how to build Gobblin * Javadocs: The full JavaDocs for each released version of Gobblin can be found [here](http://linkedin.github.io/gobblin/javadoc/latest/) * Gobblin chat room: Gitter chat room for Gobblin developers and users [here](https://gitter.im/gobblin/Lobby/) http://git-wip-us.apache.org/repos/asf/incubator-gobblin/blob/433efffe/gradle/scripts/release.gradle ---------------------------------------------------------------------- diff --git a/gradle/scripts/release.gradle b/gradle/scripts/release.gradle index 67f08c0..6598fad 100644 --- a/gradle/scripts/release.gradle +++ b/gradle/scripts/release.gradle @@ -60,11 +60,9 @@ task sourceRelease(type: Tar, dependsOn: prepare_release_config) { exclude "gradle.properties" exclude '**/build' exclude '.gradle' - // excluding gradlew and related jar because of: https://issues.apache.org/jira/browse/LEGAL-288 - exclude 'gradlew' - exclude 'gradlew.bat' + // including gradlew but excluding related jar because of: https://issues.apache.org/jira/browse/LEGAL-288 + // instructions for downloading the gradle-wrapper.jar have been added to the README exclude 'gradle/wrapper/gradle-wrapper.jar' - exclude 'gradle/wrapper/gradle-wrapper.properties' exclude '.github' exclude 'maven-sonatype' exclude 'travis'
