Skip to content

Commit 9ccf3ef

Browse files
authored
docs: Contributing docs (#526)
Update the docs to improve the Wasmtime update process and release instructions.
1 parent 81ae035 commit 9ccf3ef

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,16 @@ Compile the gem, run the tests & Ruby linter:
1717
bundle exec rake
1818
```
1919

20-
## Releasing
20+
## Updating Wasmtime
2121

22-
1. Bump the `VERSION` in `lib/wasmtime/version.rb`
22+
1. Update the version of `deterministic-wasi-ctx` in `ext/Cargo.toml`
23+
1. Update the `wasmtime-` family of crates to the new version in `ext/Cargo.toml`. Note that this process might involve code changes in case the new version contains public facing API changes.
24+
1. Bump the `VERSION` in `lib/wasmtime/version.rb` to match one-to-one the upstream `wasmtime` version.
2325
1. Run `bundle install` to bump the version in `Gemfile.lock`
24-
1. Update the changelog (requires the `github_changelog_generator` gem and being authenticated with `gh`)
26+
27+
## Releasing
28+
29+
1. On `main`, update the changelog (requires the `github_changelog_generator` gem and being authenticated with `gh`)
2530

2631
```
2732
github_changelog_generator \

0 commit comments

Comments
 (0)