You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-91Lines changed: 5 additions & 91 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,97 +8,11 @@ Automate everything involving MarkLogic with Gradle
8
8
9
9
ml-gradle is a [Gradle](https://gradle.org/)[plugin](https://docs.gradle.org/current/userguide/plugins.html) that can automate everything
10
10
you do with [MarkLogic](https://www.marklogic.com/). Deploy an application, add a host, backup a database, stub out a new project, load modules as you modify them,
11
-
run an [MLCP](https://developer.marklogic.com/products/mlcp) or [CoRB](https://developer.marklogic.com/code/corb)
12
-
or [Data Movement](http://docs.marklogic.com/guide/java/data-movement) job - if it involves MarkLogic,
11
+
run a [Flux](https://github.com/marklogic/flux) or [CoRB](https://developer.marklogic.com/code/corb) job - if it involves MarkLogic,
13
12
ml-gradle either automates it already or can be extended to do so.
14
13
15
-
You can use ml-gradle right away with the simple tutorial below, or learn more:
14
+
See our [Getting Started guide](https://github.com/marklogic/ml-gradle/wiki/Getting-started) to start using ml-gradle.
15
+
Or learn more via:
16
16
17
-
- The [ml-gradle Wiki](https://github.com/marklogic/ml-gradle/wiki) guides you through all of the ml-gradle documentation
18
-
- Read the [Getting Started guide](https://github.com/marklogic/ml-gradle/wiki/Getting-started) for more details on setting up a new project
19
-
- Browse the [example projects](https://github.com/marklogic/ml-gradle/tree/master/examples) for working examples of different ml-gradle features
20
-
21
-
**Don't want to use Gradle?** Then consider using [the ml-app-deployer Java library](https://github.com/marklogic/ml-app-deployer)
22
-
on which ml-gradle depends. ml-app-deployer provides most of the functionality within ml-gradle without having any dependency on Gradle or
23
-
Groovy - ml-gradle is then a fairly thin wrapper around ml-app-deployer to expose its functionality within a Gradle environment.
24
-
25
-
Compatibility guidelines
26
-
=========
27
-
28
-
The minimum required version of Gradle for use with ml-gradle is largely based on fixes to Gradle itself that are
29
-
related to transitive dependencies in ml-gradle. Please adhere to the guideline below for determining the minimum
30
-
version of Gradle to use based on the version of ml-gradle you are using.
31
-
32
-
| ml-gradle version | Minimum Gradle version |
33
-
|-------------------|------------------------|
34
-
| 5.0.0 or higher | Gradle 7.6.4 or higher, with Gradle 8.0 or higher recommended. |
35
-
| 4.6.0 to 4.8.0 | Gradle 7.6.0 or higher. |
36
-
| Before 4.6.0 | Gradle 7.0 or higher is recommended, though earlier versions of Gradle 6.x may work as well. |
37
-
38
-
If you wish to use Gradle 7 or higher, you must use ml-gradle 4.3.0 or higher.
39
-
40
-
You will need Java 8 or higher to run Gradle and ml-gradle. Both ml-gradle and the underlying
41
-
[MarkLogic Java Client](https://github.com/marklogic/java-client-api) dependency are tested on Java 8, 11, 17, and 21.
42
-
43
-
Start using ml-gradle
44
-
=========
45
-
46
-
ml-gradle depends on at least Java 8 or higher and [MarkLogic 9 or higher](https://developer.marklogic.com/products),
47
-
so if you have those installed, you're just a few minutes away from using ml-gradle to start a new project and deploy an
And you should see more ml-gradle logging like this:
85
-
86
-
:mlDeleteModuleTimestampsFile
87
-
:mlPrepareBundles
88
-
:mlDeployApp
89
-
:mlPostDeploy UP-TO-DATE
90
-
:mlDeploy
91
-
BUILD SUCCESSFUL
92
-
93
-
And once that's complete, you can go to the MarkLogic Admin UI on port 8001 to see the resources that have been created
94
-
(the names of these resources start with the application name you selected in the project wizard, which defaults to myApp):
95
-
96
-
- Under App Servers, a new REST server named myApp on the port you chose
97
-
- Under Databases, a new content datase named myApp-content and a new modules database named myApp-modules
98
-
- Under Forests, 3 new forests for myApp-content and 1 new forest for myApp-modules
99
-
- Under Security/Users, 3 new users, each prefixed with myApp
100
-
- Under Security/Roles, 5 new roles, each prefixed with myApp
101
-
102
-
Congratulations! You've used ml-gradle to stub out a new project and deploy its application to MarkLogic. You're now
103
-
ready to start adding more resources and modules to your project. See the links above this tutorial to learn
104
-
more about using ml-gradle.
17
+
- The [ml-gradle Wiki](https://github.com/marklogic/ml-gradle/wiki) guides you through the ml-gradle documentation.
18
+
- Browse the [example projects](https://github.com/marklogic/ml-gradle/tree/master/examples) for working examples of dozens of different ml-gradle features.
0 commit comments