Repository: incubator-groovy Updated Branches: refs/heads/master 7ecf65bc6 -> 7f442f6f9
remove gradle wrapper from source dist zip Project: http://git-wip-us.apache.org/repos/asf/incubator-groovy/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-groovy/commit/7f442f6f Tree: http://git-wip-us.apache.org/repos/asf/incubator-groovy/tree/7f442f6f Diff: http://git-wip-us.apache.org/repos/asf/incubator-groovy/diff/7f442f6f Branch: refs/heads/master Commit: 7f442f6f9e5357de4b2cdc266b484121348d68c6 Parents: 7ecf65b Author: Paul King <pa...@asert.com.au> Authored: Wed May 6 21:30:09 2015 +1000 Committer: Paul King <pa...@asert.com.au> Committed: Wed May 6 21:30:09 2015 +1000 ---------------------------------------------------------------------- README.adoc | 60 ++++++++++++++++++++++++++++++++++----------- build.gradle | 2 ++ gradle/assemble.gradle | 9 ++++--- gradle/wrapper.gradle | 24 ++++++++++++++++++ 4 files changed, 78 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/7f442f6f/README.adoc ---------------------------------------------------------------------- diff --git a/README.adoc b/README.adoc index fe57903..a625bae 100644 --- a/README.adoc +++ b/README.adoc @@ -27,7 +27,37 @@ Maven, Gradle and Ivy dependency declaration snippets are available on specific image:{bintray-watch-image}[Get automatic notifications about new "groovy" versions link={bintray-watch-link}] -== Building +== Obtaining the Source + +You don't need the source code to use Groovy but if you wish to explore its inner workings or build it for yourself there are two ways to obtain the source files. + +=== Checking out from Version Control + +Apache Groovy uses Git. The official Git repository is at: + + http://git-wip-us.apache.org/repos/asf/incubator-groovy.git + +And a mirror is hosted on Github: + + https://github.com/apache/incubator-groovy + +The Github mirror is read-only and provides convenience to users and developers to explore the code and for the community to accept contributions via Github pull requests. + +Simply `git clone` the repo (or the repo you forked via the github website) and you will have the complete source. + +=== Unpacking the src distribution + +Alternatively, you can download the source distribution and unpack it. + +If obtaining the source from this distribution and you intend to build from source, +you also need to https://gradle.org/downloads/[download] and install http://gradle.org/[Gradle] and execute one bootstrap step. +At the top directory of your unpacked source, you need to run the command: + + gradle + +This sets up the Gradle wrapper and from then on you just need the `gradlew` command instead of `gradle`. + +== Building from Source Build is image:{build-icon}[build status, link={groovy-ci}]. @@ -35,39 +65,41 @@ To build you will need: * {jdk}[JDK 1.7+] -To build everything using Gradle (the command below will download Gradle automatically, you do not need to download it first). +To build everything using Gradle: + + gradlew clean dist - ./gradlew clean dist +Note: The gradlew command automatically downloads the correct Gradle version if needed, you do not need to download it first. This will generate a distribution similar to the zip you can download on the Groovy download page. -To build everything and launch unit tests, use +To build everything and launch unit tests, use: - ./gradlew test + gradlew test If you want to launch one unit test, use this. <TestClassName> is like `groovy.GroovyMethodsTest`. - ./gradlew :test --tests <TestClassName> + gradlew :test --tests <TestClassName> -To build from IntelliJ IDEA +To build from IntelliJ IDEA: - ./gradlew jarAll idea + gradlew jarAll idea Then open the generated project in IDEA. -To build from Eclipse +To build from Eclipse: - ./gradlew jarAll eclipse + gradlew jarAll eclipse Then open the generated project and the generated subprojects in Eclipse. But be aware that Eclipse tends to be more limited in its ability to reproduce a Gradle build structure. The generated project files may contain a circular dependency which may or may not prevent Eclipse from using them. It depends on the Eclipse version, if this is an issue or not. -To build the documentation (Groovy Language Documentation) +To build the documentation (Groovy Language Documentation): - ./gradlew assembleAsciidoc + gradlew assembleAsciidoc All code samples of the documentation guide are pulled from actual test cases. To run a single documentation test case, take for example `src/spec/test/semantics/PowerAssertTest.groovy` - ./gradlew testSinglePowerAssertTest + gradlew testSinglePowerAssertTest (Note the omission of package name: class is `semantics.PowerAssertTest` but only `PowerAssertTest` is added to `testSingle`.) @@ -75,7 +107,7 @@ All code samples of the documentation guide are pulled from actual test cases. The Groovy build supports the new Java 7 JVM instruction `invokedynamic`. If you want to build Groovy with invokedynamic, you can use the project property `indy`: - ./gradlew -Pindy=true clean test + gradlew -Pindy=true clean test Please note that the following Gradle tasks generate both indy and non indy variants of the jars, so you don't need to use the system property: http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/7f442f6f/build.gradle ---------------------------------------------------------------------- diff --git a/build.gradle b/build.gradle index 89dd72b..9762c7c 100644 --- a/build.gradle +++ b/build.gradle @@ -109,6 +109,7 @@ ext { commonsHttpClientVersion = '3.1' eclipseOsgiVersion = '3.9.1-v20140110-1610' gparsVersion = '1.2.1' + gradleVersion = '2.3' ivyVersion = '2.4.0' jansiVersion = '1.11' jarjarVersion = '1.3' @@ -328,6 +329,7 @@ task ensureGrammars { } apply from: 'gradle/utils.gradle' +apply from: 'gradle/wrapper.gradle' ext.modules = { subprojects http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/7f442f6f/gradle/assemble.gradle ---------------------------------------------------------------------- diff --git a/gradle/assemble.gradle b/gradle/assemble.gradle index bf4a720..997cef1 100644 --- a/gradle/assemble.gradle +++ b/gradle/assemble.gradle @@ -45,6 +45,9 @@ ext.srcSpec = copySpec { 'cruise/**', '.clover/*', 'local.build.properties', + 'gradle/wrapper', + 'gradlew', + 'gradlew.bat', 'cobertura.ser', 'junitvmwatcher*.properties', 'out', @@ -87,15 +90,15 @@ ext.allManifest = manifest { 'Extension-Name': 'groovy', 'Specification-Title': 'Groovy: a powerful, dynamic language for the JVM', 'Specification-Version': groovyBundleVersion, - 'Specification-Vendor': 'The Codehaus', + 'Specification-Vendor': 'The Apache Software Foundation', 'Implementation-Title': 'Groovy: a powerful, dynamic language for the JVM', 'Implementation-Version': groovyBundleVersion, - 'Implementation-Vendor': 'The Codehaus', + 'Implementation-Vendor': 'The Apache Software Foundation', 'Bundle-ManifestVersion': '2', 'Bundle-Name': 'Groovy Runtime', 'Bundle-Description': 'Groovy Runtime', 'Bundle-Version': groovyBundleVersion, - 'Bundle-Vendor': 'The Codehaus', + 'Bundle-Vendor': 'The Apache Software Foundation', 'Bundle-ClassPath': '.', 'Eclipse-BuddyPolicy': 'dependent', 'DynamicImport-Package': '*', http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/7f442f6f/gradle/wrapper.gradle ---------------------------------------------------------------------- diff --git a/gradle/wrapper.gradle b/gradle/wrapper.gradle new file mode 100644 index 0000000..92d9653 --- /dev/null +++ b/gradle/wrapper.gradle @@ -0,0 +1,24 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +defaultTasks 'downloadWrapper' + +task downloadWrapper(type: Wrapper) { + description = "Download the gradle wrapper and requisite files. Overwrites any existing wrapper files." + gradleVersion = project.gradleVersion +}
