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: CONTRIBUTING.md
+37-7Lines changed: 37 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Looking to build the code from source? Look no further.
27
27
#### Prerequisites
28
28
You need:
29
29
30
-
- MarkLogic Server 9.0-7 or later
30
+
- MarkLogic Server (see [Version Compatibility](https://docs.marklogic.com/datahub/refs/version-compatibility.html) for the correct version)
31
31
- Java JDK 8 or later
32
32
- Gradle 4.6 or later
33
33
- A decent IDE. (Recommended: IntelliJ)
@@ -44,18 +44,48 @@ cd /path/to/data-hub-project/
44
44
```
45
45
46
46
47
-
#### Making Changes to the Hub Gradle Plugin
47
+
#### Building and using the Data Hub Java library
48
48
49
-
If you are testing a change to the ml-data-hub Gradle plugin or a cutting-edge development version, you might want to use a local copy of the Gradle plugin in your Data Hub project. These situations are rare.
49
+
If you wish to make changes to or try out the latest code in the Data Hub Java library (marklogic-data-hub-(version).jar), follow
50
+
these instructions:
50
51
52
+
1. Publish the library to your local Maven repository (defaults to ~/.m2/repository).
53
+
54
+
```bash
55
+
cd /path/to/marklogic-data-hub/
56
+
./gradlew publishToMavenLocal
57
+
```
58
+
59
+
2. In the build.gradle file for the project that will use the library, add your local Maven repository as a repository if it's not alreaded included:
60
+
61
+
```bash
62
+
repositories {
63
+
mavenLocal()
64
+
}
65
+
```
66
+
67
+
3. Assuming that you're using Gradle's java plugin, add the library as a dependency to your project:
The version is defined in gradle.properties in the marklogic-data-hub root project directory. You can override this if
75
+
desired when publishing to your local Maven repository - e.g.
76
+
77
+
./gradlew publishToMavenLocal -Pversion=myVersion
78
+
79
+
80
+
#### Building and using the Data Hub Gradle Plugin
81
+
82
+
If you are testing a change to the ml-data-hub Gradle plugin or a cutting-edge development version, you might want to use a local copy of the Gradle plugin in your Data Hub project.
51
83
To use a local copy of the Gradle plugin in your Data Hub project, you must tell Gradle to use your local copy instead of the one in the cloud.
52
84
53
-
1. Publish your Data Hub Plugin to the local Maven repository.
85
+
1. Publish the plugin to yourlocal Maven repository (defaults to ~/.m2/repository).
0 commit comments