Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.14 KB

RELEASE.md

File metadata and controls

50 lines (32 loc) · 2.14 KB

Release

First Time Setup

  • Run mage init to install tooling.
  • Install trunk (quick install script: curl https://get.trunk.io -fsSL | bash)
  • Install aqua. Configure your PATH per directions.
  • Run aqua install for tooling such as changie or others for the project.
    • At this time, it expects you have to Go pre-installed.

Release Notes

This project uses an different approach to release, driving it from changelog and versioned changelog notes instead of tagging.

Use changie quick start for basic review.

Creating New Notes

  • During development, new changes of note get tracked via changie new.
  • This can span many pull requests, whatever makes sense as version to ship as changes to users.
  • To release the changes into a version, changie batch <major|minor|patch>. Default to a patch version unless new features or breaking changes are made.

Keep your summary of changes that users would care about in the .changes/ files it will create.

Release

Update CHANGELOG.md by running changie merge which will rebuild the changelog file with all the documented notes.

Format & Lint

  • Run trunk fmt --all; trunk check --all to finalize run through.
  • Push changelog via PR or direct if you have permissions and this will trigger the release-composite. If any issues, retrigger manually via gh workflow run release-composite.
  • Release should be published in the releases

FAQ

What drives the version number for the release?

Changie notes are named like v1.0.4.md. This version number will be used to set the version of the release, so the docs in essence will be the version source of truth.

Conventional Commit

We use conventional commit. Pull requests must adhere to this to be merged.

Description should be bullet point list or longer-form content to describe anything the title doesn't make clear.