open-telemetry / opentelemetry-rust

The Rust OpenTelemetry implementation

https://opentelemetry.io

Apache License 2.0

1.81k stars 417 forks source link

Release documentation and process #1326

Open TommyCpp opened 10 months ago

TommyCpp commented 10 months ago

We need to document the release process to help us release more frequently. We should have a step-by-step guide to release a create

TommyCpp commented 10 months ago

1327 should help us release more confidently

jtescher commented 10 months ago

Working on getting github group access for @open-telemetry/rust-maintainers on crates.io, at that point we can document how any maintainer can run the release process. (at this point it's just running cargo publish)

hdost commented 9 months ago

Update from the SIG meeting @jtescher is working with Community Managers to allow access so that the github group can be used to add users to crates.io

hdost commented 7 months ago

I saw just a couple days ago that the org should now be readable by crates.io

https://github.com/open-telemetry/community/issues/1938 is completed.

hdost commented 7 months ago

The release process could be something like:

Check pending PRs and validate if they should be a blocker for a next release (merge as necessary)
Create a release PR
- For each crate
- Bump appropriate version
- Update change logs to reflect
- update API/SDK version as necessary
Merge the PR
- Get reviews from other Maintainers
- Ensure that there haven't been any interfering PRs
Tag the release commit (TBD convention)
Create Github Release
Publish to crates.io using the version as of the release commit
- TBD include steps or links cargo release
Post to #otel-rust on CNCF Slack.