removed multiple examples and created just a single one

Author: Dermot Smyth

examples/disconnected-project-using-plugins-advanced/README.md

@@ -0,0 +1,98 @@
+# Standalone Gradle deployer with ml-gradle
+
+## Quickstart 
+
+Summary of the steps required. See sections below for more detailed steps
+
+*NOTE:* The use of gradlew is required
+
+1. Create standalone deployer zip
+```
+./gradlew makeOfflineZip 
+```
+2. Copy zip (build/distributions/offline.zip) to desired location / server and unzip
+
+3. Run  disconnected tasks from unzip location
+```
+./gradlew mlDeploy -Pdisconnected=true
+```
+
+
+## Overview 
+
+An example of how to create a completely self-contained deployer zip that contains -
+1. All of the plugin / depencencies required to run the deployment (including ml-gradle)
+2. The gradle distribution
+
+Once the zip has been created, you only need Java to run the deployment tasks
+
+This approach is useful when you need to create a package that does not require any external ressources (e.g. maven/gradle repositories) to perform deployment operations. 
+
+## Requirements
+
+* Java 8/9
+* Internet connection (for creation of zip only)
+
+
+## How it works 
+
+This project will -
+* Download all of the required dependencies (including plugins) into the 'build/offline/maven-repo' directory in the project.
+* Download the gradle binary distribution (zip) into the 'build/offline/gradle/wrapper' directory in the project
+* Create an offline.zip in build/distributions that contains 
+    * the gradle project itsself
+    * all of the required depenencies 
+    * the gradle distribution that works with the gradlew executable
+    
+
+## Usage 
+
+*NOTE:* It is important to use the gradlew executable as it will download the gradle distribution that will be encorporated into the self-contained deployer zip
+
+## 1. Create the self-contained deployer zip
+
+*NOTE:* This needs to be executed from a machine with access to the internet. It will create the zip at the location build/distributions/offline.zip 
+
+#### Linux / Mac
+
+```
+./gradlew makeOfflineZip 
+```
+
+#### Windows
+
+```
+gradlew makeOfflineZip 
+```
+
+
+## 2. Unzip the distribution
+
+Copy the created offline.zip to the desired location and unzip
+
+```
+unzip offline.zip  
+```
+
+## 3. Execute disconnected the gradle tasks 
+
+From the directory that you have unzipped the offline.zip file into 
+
+```
+./gradlew mlDeploy -Pdisconnected=true
+```
+
+This will use the jars that you have already downloaded to 'build/offline/maven-repo'
+
+## Customise
+
+**IMPORTANT**: If you want to include dependencies for a configuration (e.g. compile, runtime, mlcp etc), then you need to modify the 'downloadToProjectMavenRepo' task to include the relevant configuration. E.g. by adding 'configurations.compile.files' to the beginning of the task, all of the dependencies for the 'compile' task will be downloaded.
+
+E.g. (assuming you are using the java plugin), the configuration below will download all the compile and runtime dependencies that you have defined 
+
+```
+task downloadToProjectMavenRepo(type: Copy) {
+    configurations.compile.files
+    configurations.runtime.files
+     ...
+```

examples/disconnected-project-using-plugins-advanced/settings.gradle

@@ -1,14 +1,14 @@
 plugins {
-    id 'java'
+    id 'java' //optional - delete if not needed
     id 'net.saliman.properties' version '1.4.6'
-    id 'com.marklogic.ml-gradle' version '3.6.3'
+    id 'com.marklogic.ml-gradle' version '3.7.1'
 }
 
 repositories {
     // To use gradle in disconnected mode, you just need to set the 'disconnected' property. E.g. gradle compileJava -Pdisconnected 
-    if ( project.hasProperty("disconnected") && !"FALSE".equalsIgnoreCase(this.properties['disconnected'])) {
+    if ( project.hasProperty("disconnected") && !"FALSE".equalsIgnoreCase(disconnected)) {
         println "Using offline repositories"
-        maven {url uri( 'project-maven-repo' ) }
+        maven {url uri( projectMavenRepo ) }
     } else {
         println "Using online repositories"
         jcenter()
@@ -17,32 +17,29 @@ repositories {
 }
 
 configurations {
-	mlcp
+	mlcp //example if you want to use mlcp. Delete otherwise
 }
 
 dependencies {
-    // sample java compile dependency
+    // sample java compile dependency. Remove if not required
     compile 'com.marklogic:marklogic-xcc:9.0.4'
 
-    //sample mlcp 
+    //sample mlcp dependency. Remove if not required
     mlcp "com.marklogic:mlcp:9.0.5"
 }
 
 
+
 /**
  * START: Disconnected gradle tasks
  */
 gradle.taskGraph.whenReady { graph ->
-    if (graph.hasTask(makeOfflineZip)) {
-        if (!project.gradle.gradleUserHomeDir.equals(new File(rootDir,"project-gradle-cache"))) {
-            throw new GradleException("Please set the gradle user home property to 'project-gradle-cache' on the gradle command line - e.g. \n " +
-            "gradle -Dgradle.user.home=project-gradle-cache makeOfflineZip")
-        }
-    }
     if (graph.hasTask(downloadToProjectMavenRepo)) {
-        if (!project.gradle.gradleUserHomeDir.equals(new File(rootDir,"project-gradle-cache"))) {
-            throw new GradleException("Please set the gradle user home property to 'project-gradle-cache' on the gradle command line - e.g. \n " +
-            "gradle -Dgradle.user.home=project-gradle-cache downloadToProjectMavenRepo")
+        println project.gradle.gradleUserHomeDir
+        if (!project.gradle.gradleUserHomeDir.equals(new File(rootDir,projectGradleHome))) {
+            throw new GradleException("Please set the gradle user home property to $projectGradleHome on the gradle command line - e.g. \n " +
+            (System.getProperty("os.name").startsWith("Windows") ? "" : "./") +
+            "gradlew -Dgradle.user.home=$projectGradleHome <task_to_execute>")
         }
     }
 }
@@ -53,12 +50,11 @@ task downloadToProjectMavenRepo(type: Copy) {
      * These are defined in the 'dependencies' block. E.g. you need to include 
      * configurations.compile.files if you want your java 'compile' dependencies downloaded
      */  
-    //configurations.runtime.files
-    configurations.compile.files
-    configurations.mlcp.files
+    configurations.compile.files //includes 'java' compile dependencies. Remove if not needed
+    configurations.mlcp.files //includes 'mlcp' dependencies. Remove if not needed
 
     from new File(gradle.gradleUserHomeDir, 'caches/modules-2/files-2.1') // correct as of gradle 4.7
-    into 'project-maven-repo'
+    into new File(rootDir, projectMavenRepo)
     eachFile {
         List<String> parts = it.path.split('/')
         it.path = (parts[0].replace('.','/') + '/' + parts[1]) + '/' + parts[2] + '/' + parts[4]
@@ -68,7 +64,7 @@ task downloadToProjectMavenRepo(type: Copy) {
 
 task makeOfflineZip(type: Zip, dependsOn: downloadToProjectMavenRepo) {
   from rootDir
-  excludes = ['.tmp','.gradle','build','project-gradle-cache']
+  excludes = ['.tmp','.gradle','build/gradle-home','build/distributions','build/offline/gradle/wrapper/dists']
   destinationDir(file('build/distributions'))
   archiveName =  'offline.zip' 
   doLast {
@@ -78,4 +74,4 @@ task makeOfflineZip(type: Zip, dependsOn: downloadToProjectMavenRepo) {
 
 /**
  * END: Disconnected gradle tasks
- */
+ */

examples/disconnected-project-using-plugins-and-gradlew/README.md

@@ -0,0 +1,3 @@
+projectMavenRepo=build/offline/maven-repo
+# if you change this, you need to modify gradlew and gradlew.bat also
+projectGradleHome=build/gradle-home

examples/disconnected-project-using-plugins-advanced/build.gradle renamed to examples/disconnected-project-using-plugins-and-gradlew/build.gradle

@@ -0,0 +1,5 @@
+distributionBase=PROJECT
+distributionPath=build/offline/gradle/wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.8-bin.zip
+zipStoreBase=PROJECT
+zipStorePath=build/offline/gradle/wrapper