vortex icon indicating copy to clipboard operation
vortex copied to clipboard

Release process improvements

Open AdamGS opened this issue 11 months ago • 1 comments

  • [ ] Check for circular dependencies
  • [ ] Yank crates automatically on a failed release.
  • [ ] Test releases periodically with RC/nightly/beta releases. Take releases from dedicated branch instead of develop, so we don't introduce more noise in case of a failed release.
  • [ ] Use cargo publish to check crates can actually be packaged and published. Tried an initial thing in https://github.com/spiraldb/vortex/pull/2571 and it took over 12 minutes, but maybe we can call some of that logic directly and get a faster check.
  • [ ] Release binaries for vx, allowing users to more easily use it (and get faster installations with bininstall).
  • [ ] Keep a centralized changelog that goes out with the top level crate, in addition to their dedicated changelogs + github releases for all.

AdamGS avatar Feb 28 '25 20:02 AdamGS

Seems like ratatui is a pretty good example, they use a tool called cliff to generate their changelog and seems like release-plz accepts that.

  • Example release PR - https://github.com/ratatui/ratatui/pull/1671
  • Github releases - https://github.com/ratatui/ratatui/releases
  • release-plz config https://github.com/ratatui/ratatui/blob/main/release-plz.toml
  • cliff config - https://github.com/ratatui/ratatui/blob/main/cliff.toml

AdamGS avatar Apr 03 '25 10:04 AdamGS