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
* update apachecommons2->3.12
* bump spring 4.3->5.3.24
* update lombok->1.18.24, junit -> 4.13.2, slf4j->1.7.36
* include java17 in feature matrix
* fix it tests
* run it on java17
* docs and schedule monthly build
* fix typo in prs.yml
Co-authored-by: richard <ra22597@gmail.com>
Copy file name to clipboardExpand all lines: Readme.md
+19-7Lines changed: 19 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,16 @@ It was initially contributed by [ResearchSpace](www.researchspace.com) in Octobe
7
7
8
8
### Dependencies
9
9
10
-
This project requires Java 8 to compile and run.
11
-
It also uses Spring-web (to provide low-level HTTP request/response parsing.)
12
-
The Sword client library is included in this project as a jar file as it is not available
10
+
This project requires Java 8 minimum to compile and run.
11
+
12
+
It is built and tested on Java 11 and Java 17.
13
+
14
+
It also uses Spring-web (to provide low-level HTTP request/response parsing.)
15
+
16
+
The Sword client library is included in this project as a jar file, as it is not available
13
17
in a public maven repository.
14
18
15
-
### Building
19
+
### Gradle
16
20
17
21
This project is built using Gradle. You can build straight away without needing to install anything:
18
22
@@ -22,7 +26,7 @@ which will compile, run unit tests (but not integration tests) and build a jar f
22
26
23
27
### Running integration tests
24
28
25
-
Integration tests require a connection to a Dataverse instance.
29
+
Integration tests require a connection to a Dataverse instance.
26
30
In order to connect to a Dataverse for running tests, the following configuration is set up in `test.properties`.
27
31
28
32
dataverseServerURL=https://demo.dataverse.org
@@ -59,7 +63,6 @@ If using Maven, add this to your pom.xml file (thanks AleixMT).
59
63
</dependencies>`
60
64
```
61
65
62
-
63
66
Or, you can run:
64
67
65
68
./gradlew clean install
@@ -101,9 +104,18 @@ Searching uses a builder pattern to build a search query:
101
104
There is no explicit synchronisation performed in this library. The Dataverse configuration is stored in the
102
105
internal state of implementation classes, so new instances of `DataverseAPIImpl` should be used for each request if running in a multi-threaded environment connecting to different Dataverses.
103
106
107
+
## Github actions
108
+
109
+
Tests and integration tests run on:
110
+
- pull request
111
+
- merge to master,
112
+
- once a month, to detect regressions in API calls to https://demo.dataverse.org.
113
+
104
114
## Developing
105
115
106
-
This project makes use of [Project Lombok](https://projectlombok.org) which greatly speeds up the development of POJO classes to wrap JSON data structures. There are [instructions](https://projectlombok.org/features/index.html) on how to add it to your IDE.
116
+
This project makes use of [Project Lombok](https://projectlombok.org) which greatly speeds up the development of POJO classes to wrap JSON data structures.
117
+
118
+
There are [instructions](https://projectlombok.org/features/index.html) on how to add it to your IDE.
0 commit comments