Skip to content

RELEASE.md

Latest commit

 

History

History
29 lines (18 loc) · 1.08 KB

RELEASE.md

File metadata and controls

29 lines (18 loc) · 1.08 KB

Releasing SlateDB

Cadence

We aim to release a new version of SlateDB every 2 months. This is a guideline, not a strict rule. The actual cadence may vary based on the amount of work that has been completed.

Proposal

Anyone may propose a new SlateDB release by opening a Github issue.

Approval

GOVERNANCE.md defines how a release is approved.

Publication

SlateDB releases are published using a Github release action defined in .github/workflows/release.yml. To create a new release:

  1. Go to the release action page
  2. Input a version value in the format X.Y.Z and click Run workflow.

The release action will do the following:

  1. Verify that the version adheres to the semantic versioning format.
  2. Check out the latest code from the main branch.
  3. Update the version in Cargo.toml to the specified version.
  4. Commit the changes and push to the main branch.
  5. Create a Github release with the specified version and auto-generated release notes.
  6. Publish a release to crates.io.