-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add instructions for releasing new versions
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. |