Skip to content

Commit 8bceda1

Browse files
authored
docs: add RELEASING.md
1 parent 7317ce5 commit 8bceda1

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

RELEASING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Releasing the Chicory SDK
2+
3+
- Releases are kicked off by the [`release`][release] GitHub Action Workflow.
4+
- The workflow takes one parameter, the version:
5+
- `version` is a `x.x.x` version number (no `v` prefix) or a `x.x.x-SNAPSHOT` version for snapshot release (e.g. `999-SNAPSHOT` or `1.0.0-SNAPSHOT`)
6+
- When the release process is triggered, the project is built, and all the tests are run.
7+
- If the run is successful, then it is published to Maven Central. This usually takes approximately 20 minutes; the build will wait to exit until the package is acknowledged to be published
8+
- If publishing is successful, then **a git tag `x.x.x` is automatically created and pushed to the `main` branch**
9+
- NOTE: if the `version` is a snapshot release, then NO tag is created!
10+
11+
[release]: https://github.com/extism/chicory-sdk/actions/workflows/release.yaml

0 commit comments

Comments
 (0)