Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (34 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 1.7 KB

Contributing

wasmtime-rb is a Bytecode Alliance project. It follows the Bytecode Alliance's Code of Conduct and Organizational Code of Conduct.

Getting started

Install dependencies:

bundle install

Compile the gem, run the tests & Ruby linter:

bundle exec rake

Updating Wasmtime

  1. Update the version of deterministic-wasi-ctx in ext/Cargo.toml
  2. 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.
  3. Bump the VERSION in lib/wasmtime/version.rb to match one-to-one the upstream wasmtime version.
  4. Run bundle install to bump the version in Gemfile.lock

Releasing

  1. On main, update the changelog, running the following script (requires the github_changelog_generator gem and being authenticated with gh):
./scripts/generate-changelog.sh
  1. Commit your changes to the main branch and push them. Ensure you are not doing this on a fork of the repository.
  2. Create a new tag for that release, prefixed with v (git tag v1.0.0):
git tag v$(grep VERSION lib/wasmtime/version.rb | head -n 1 | cut -d'"' -f2)
git push --tags
  1. The release workflow will run and push a new version to RubyGems and create a new draft release on GitHub. Edit the release notes if needed, then mark the release as published when the release workflow succeeds.