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.

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

Conversation

rasendubi
Copy link
Collaborator

We had a small incident with [email protected] tag pushed without updating the version strings so it tried to publish new artifacts into already released [email protected] on pypi. Luckily, none of artifacts were actually pushed because they already exist.

This incident went somewhat unnoticed because there were no GitHub release, just a tag. So I only noticed this when trying to push a new release and found that the tag already exists.

I have rectified this by deleting the old [email protected] tag that did not have effect and created a proper release.

This PR is a follow-up and:

  • Modifies Python workflow to require a GitHub release, so releases are more visible.
  • Adds documentation on the release process.

This should help with visibility as tags have much less information
and are less visible.

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

Copy link
Contributor

@sameerank sameerank left a comment

Choose a reason for hiding this comment

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

Thank you! I would also appreciate more notes on local env setup (in a future PR is fine), e.g.

  • what do I need to do before I run npm run with-server test:python to see passing tests?
  • can I create a distribution package for python to install locally and try out before publishing to pypi?

@rasendubi rasendubi merged commit b114013 into main Oct 16, 2024
24 checks passed
@rasendubi rasendubi deleted the chore-clarify-release-process branch October 16, 2024 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants