Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 1.74 KB
Raw

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

If running the Run Examples step of CI fails

If there was an update to deterministic-wasi-ctx, try running:

$ cd examples/rust-crate
$ cargo update -p deterministic-wasi-ctx

If the lock file for the example Rust crate changed, commit and push that change.

Releasing

  1. Bump the VERSION in lib/wasmtime/version.rb
  2. Run bundle install to bump the version in Gemfile.lock
  3. Update the changelog (requires the github_changelog_generator gem and being authenticated with gh)
github_changelog_generator \
  -u bytecodealliance \
  -p wasmtime-rb \
  -t $(gh auth token) \
  --future-release v$(grep VERSION lib/wasmtime/version.rb | head -n 1 | cut -d'"' -f2)
  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.