Skip to content

Commit f4a49b4

Browse files
committed
document shadowJar jar file building
1 parent 1c4a781 commit f4a49b4

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434

3535
- name: Gradle build
3636
id: ci-gradle-build
37-
run: ./gradlew clean assemble
37+
run: ./gradlew clean shadowJar
3838

3939
# - name: Gradle tests
4040
# run: ./gradlew test

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ at the moment, the jar file is tagged as '5.0.0-SNAPSHOT'
1010
./gradlew clean publishToMavenLocal
1111
```
1212

13+
or (jar file **must** be complete then loaded by python wrappers
14+
```
15+
./gradlew shadowJar
16+
```
17+
1318
## python part: test locally
1419

1520
### Conda environment
@@ -65,6 +70,7 @@ open htmlcov/index.html
6570
./python_examples/simple_query.py -j $PWD/build/libs/corese-python-5.0.0-SNAPSHOT-jar-with-dependencies.jar
6671
```
6772

73+
Remark: to build this jar file, you must run `./gradlew shadowJar` before
6874

6975
### experimental: run a simple example using jpype bridge (without installing)
7076

0 commit comments

Comments
 (0)