Skip to content

Commit 1f824a8

Browse files
committed
Clean up Java readme
1 parent d746c2a commit 1f824a8

2 files changed

Lines changed: 41 additions & 33 deletions

File tree

java/README.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,57 @@ This is the top-level project for the Java API and backend bindings for the Pris
66
* native/ contains a native binding for the Prism shared library
77
* wasm/ contains a Chicory-based WASM build and binding
88

9+
## Building the Java components
10+
11+
Some files need to be generated before the Maven artifacts can build:
12+
13+
### Templated sources
14+
15+
Sources under `api` are generated from templates in `../templates`. Those sources are generated using the follow command line:
16+
17+
```
18+
$ PRISM_EXCLUDE_PRETTYPRINT=1 PRISM_SERIALIZE_ONLY_SEMANTICS_FIELDS=1 bundle exec rake templates
19+
```
20+
21+
The files go under `api/target/generated-sources/java` and will be removed with `mvn clean`.
22+
23+
### WASM build of Prism
24+
25+
The `wasm` project needs a WASM build of Prism to be generated with the following command:
26+
27+
```
28+
$ make java-wasm WASI_SDK_PATH=<path to WASI sdk>
29+
```
30+
31+
The files go under `wasm/target/generated-sources/wasm` and will be removed with `mvn clean`.
32+
33+
### Build and install
34+
35+
The projects can be built and installed into a local Maven repository by running the following command:
36+
37+
```
38+
$ mvn install
39+
```
40+
941
## Updating versions
1042

1143
Run the following command to update all module versions:
1244

1345
```
14-
mvn versions:set -DnewVersion=1.2.3-SNAPSHOT
46+
$ mvn versions:set -DnewVersion=1.2.3-SNAPSHOT
1547
```
1648

1749
## Releasing
1850

19-
Snapshots can be deployed with `mvn deploy` while the versions are `-SNAPSHOT`.
51+
Snapshots can be deployed to the Maven snapshot repository while the versions end with `-SNAPSHOT`:
2052

21-
When releasing to Maven Central, all projects should be released together using the `release` profile:
53+
```
54+
$ mvn deploy
55+
```
56+
57+
When releasing to Maven Central, all projects should be released together using the `release` profile, which will use the local default GPG key to sign the packages:
2258

2359
```
24-
mvn clean deploy -Prelease
60+
$ mvn deploy -Prelease
2561
```
62+

java/wasm/README.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)