Skip to content

Commit 4d023b4

Browse files
committed
Update CONTRIBUTING
1 parent 959c245 commit 4d023b4

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,33 @@ Verify a single file from the CLI:
2828

2929
Code formatting runs automatically via `formatter-maven-plugin` during the `validate` phase.
3030

31+
## Release
32+
33+
Releases are published through GitHub Actions when release tags are pushed to
34+
`main`:
35+
36+
- `v*` tags publish `liquidjava-verifier` through the `publish-verifier`
37+
workflow.
38+
- `api-v*` tags publish `liquidjava-api` through the `publish-api` workflow.
39+
40+
Use `release.sh` from the repository root to publish a release.
41+
The script automatically verifies the build and tests, bumps the module version, commits the version change, creates the matching tag, and pushes them to `main`.
42+
43+
```bash
44+
./release.sh verifier # publishes liquidjava-verifier
45+
./release.sh api # publishes liquidjava-api
46+
```
47+
48+
You can also pass the release version explicitly:
49+
50+
```bash
51+
./release.sh verifier 1.2.3
52+
./release.sh api 1.2.3
53+
```
54+
55+
Run releases from a clean `main` branch. Once the tag is pushed, the matching
56+
GitHub Actions workflow publishes the module to Maven Central.
57+
3158
## Adding test cases
3259

3360
Tests live under `liquidjava-example/src/main/java/testSuite/` and are auto-discovered:

0 commit comments

Comments
 (0)