Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 2.18 KB

releasing.md

File metadata and controls

73 lines (48 loc) · 2.18 KB

Releasing Flintlock

These instructions will change when we start supporting previous versions whilst using main for future versions.

Determine release version

The projects follows semantic versioning and so the release version must adhere to this specification. Depending on the changes in the release you will need to decide the next appropriate version number.

Its advised that you pull the tags and view the latest release (i.e. tag):

git pull --tags

git describe --tags --abbrev=0

Create tag

  • Checkout upstream main
  • Create a tag with the version number:
RELEASE_VERSION=v0.1.0-alpha.1
git tag -s "${RELEASE_VERSION}" -m "${RELEASE_VERSION}"
  • Push the tag (to upstream if working from a fork)
git push origin "${RELEASE_VERSION}"
  • Check the release GitHub Actions workflow completes successfully. This may take a few minutes as it runs the e2es as part of the process.

Edit & Publish GitHub Release

  • Got to the draft release in GitHub.
  • Make any edits to generated release notes
    • If there are any breaking changes then manually add a note at the beginning of the release notes informing the user what they need to be aware of/do.
    • Sometimes you may want to combine changes into 1 line
  • If this is a pre-release tick This is a pre-release
  • Publish the draft release and when asked say yes to creating a discussion.

Commit a new buf tag

We have gRPC API docs hosted on buf.build. If the API has changed, you'll need to update these.

Log in creds can be found in the shared Team Quicksilver 1Pass vault.

Generate a new token.

Log in locally:

buf registry login
# username is liquidmetal-dev
# key is the token you generated

Push a new tag:

buf push --tag "${RELEASE_VERSION}"

If you get the message The latest commit has the same content; not creating a new commit. then it means there hasn't been changes to the API so you didn't need to do this.

Announce release

When the release is available announce it in the #liquid-metal slack channel.