Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 1.55 KB

README.md

File metadata and controls

33 lines (19 loc) · 1.55 KB
Raw

AppPack CLI

goreleaser

The command line interface for AppPack.io.

End user documentation

Development

When writing commit logs think of the impact to the end user. Commits are listed in the release notes on GitHub with the exception of the prefixes defined in .goreleaser.yml. Use those whenever you're making changes which don't effect the end-user.

Release Process Overview

Here's a step-by-step guide to releasing a new version of AppPack:

Prepping for release

  • Update CHANGELOG.md with all relevant user-facing changes associated with the upcoming release, including the release tag and the date.
  • Use SemVer guidelines when incrementing version numbers.

Automated Release with GoReleaser

  • Push you changes to main
  • Tag the commit with the version number prefixed by v. For example, to tag 9.7.5, run git tag -s v9.7.5
  • git push --tag
  • GoReleaser will take over through Github Actions, creating a new release with the version number specified in your tag. It will also compile the latest code, create OS-specific binaries, and upload these artifacts to the release assets on GitHub.

Update docs

  • Run the docs workflow to update the docs once GoReleaser completes. Make sure to run workflow from deploy/prod branch to make it live.