Skip to content

Commit 318b8ee

Browse files
committed
Add release instructions
Add RELEASE.md with release intructions Signed-off-by: Jorge Prendes <jorge.prendes@gmail.com>
1 parent f4bf9fe commit 318b8ee

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

RELEASE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Release Process
2+
3+
This document describes the steps to release a new version of the crate or wasi-demo-app images.
4+
5+
## Crate Release Process
6+
7+
### Release Steps
8+
9+
1. Bump package and dependency versions in:
10+
* `./compiler/Cargo.toml`: Bump the package version as needed.
11+
* `./ttrpc-codegen/Cargo.toml`: Bump the package version as needed.
12+
* `./Cargo.toml`: Bump package version as needed. Then bump the workspace dependencies version to match the respective crates versions.
13+
2. Commit the changes and get them merged in the repo.
14+
2. Dry run the `cargo publish` command as follow
15+
```bash
16+
cargo +nightly publish \
17+
-Z package-workspace \
18+
--dry-run \
19+
--locked \
20+
-p ttrpc \
21+
-p ttrpc-codegen \
22+
-p ttrpc-compiler
23+
```
24+
2. If the dry run succeeds, publish the crates that need publishing using `cargo publihs -p <crate>` in the following order
25+
1. `ttrpc-compiler`
26+
2. `ttrpc-codegen`
27+
3. `ttrpc`

0 commit comments

Comments
 (0)