Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: clarify release process #44

Merged
merged 2 commits into from
Oct 16, 2024
Merged

chore: clarify release process #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb8dada
chore(python): only release on new GitHub releases, not plain tags
rasendubi Oct 15, 2024
0d12520
docs: add instructions for releasing new versions
rasendubi Oct 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .github/workflows/python.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ on:
push:
branches:
- main
- master
tags:
- '*'
release:
types: [published]
pull_request:
workflow_dispatch:

Expand Down
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding is this should be treated with its own semver tree; for example breaking changes in eppo core might not be breaking changes up stream?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, all components have independent versioning

- 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.
Loading