Skip to content

Document Release Process #12

@azenla

Description

@azenla

The new release process is as follows, but we should put this in a proper document:

New release process for Sprout (for my future doc):

  1. Bump the version in Cargo.toml to the right version and run ./hack/build.sh
  2. Commit the result to main via a PR, with the commit "sprout: version x.y.z", the final commit message should be like sprout: version x.y.z (#PR_NUMBER) when rebased.
  3. Create a tag manually for the release, ex: v0.0.8, using -s to sign the tag: git tag -s v0.0.8, put in the message just v0.0.8 except replacing it with the version.
  4. Draft a release (DONT CLICK PUBLISH) named the release with the right tag, clicking the Generate Release Notes button. Usually we also add a newline after every section header as GitHub doesn't always do that.
  5. Dispatch the release workflow with the workflow running from that tag and the Release Tag input as the tag name (ex: release-tag: v0.0.8), this will build, upload, attest, and publish the draft release.
  6. DONE

This presents a proper release that has the artifacts without any release being in flux, making sure consistency is maintained

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions