Skip to content

Commit

Permalink
docs: add instructions for releasing new versions
Browse files Browse the repository at this point in the history
  • Loading branch information
rasendubi committed Oct 15, 2024
1 parent bb8dada commit 0d12520
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,22 @@

1. Install [rustup](https://rustup.rs/).
2. Install Ruby using your preferred package manager.

### Release process

To release a new version of SDK:
1. Make sure that version strings have been updated:
- Eppo core: [eppo_core/Cargo.toml](eppo_core/Cargo.toml)
- Rust: [rust-sdk/Cargo.toml](rust-sdk/Cargo.toml)
- Python: [python-sdk/Cargo.toml](python-sdk/Cargo.toml)
- Ruby: [ruby-sdk/lib/eppo_client/version.rb](ruby-sdk/lib/eppo_client/version.rb) and [ruby-sdk/ext/eppo_client/Cargo.toml](ruby-sdk/ext/eppo_client/Cargo.toml)
2. If SDK depends on a new version of `eppo_core`, the core should be released first.
3. [Create a new release](https://github.com/Eppo-exp/rust-sdk/releases/new) in GitHub interface.
- For tag, use one of the following formats (choose "create new tag on publish"):
- `[email protected]`
- `[email protected]`
- `[email protected]`
- `[email protected]`
- For generating release notes, select previous tag from the same SDK (e.g., when releasing `[email protected]`, the previous tag should be `[email protected]`). Auto-generate release notes, prune entries that are not relevant for the SDK (e.g., Python SDK release should not list PRs for Ruby).
- Publish release.
- CI will automatically push a new release out to package registries.

0 comments on commit 0d12520

Please sign in to comment.