Skip to content

release.md

Latest commit

 

History

History
60 lines (37 loc) · 2.68 KB

release.md

File metadata and controls

60 lines (37 loc) · 2.68 KB

Apko Release Process

Automated releases

Apko uses an automated release process via GitHub Actions. Releases are handled by the Release action.

Scheduled releases

The release workflow runs automatically every Monday at 00:00 UTC. It will:

  1. Check if there have been any changes since the last release
  2. Automatically bump the patch version if changes are detected
  3. Create a new tag and release with generated release notes
  4. Build and attach release artifacts using GoReleaser

Manual releases

To trigger a release manually:

  1. Go to the Release workflow
  2. Click "Run workflow"
  3. Select the branch (usually main)
  4. Click "Run workflow"

The workflow will automatically determine if a release is needed and create one if there have been changes since the last release.

Monitor the release automation

The release job takes 20 to 30 minutes to execute and will:

  • Create a new patch version tag
  • Generate release notes
  • Build and sign release artifacts with Cosign
  • Publish the release to GitHub

Once the Release action has completed successfully, find your release on the releases page

You can make editorial changes to the release notes after automation completes if needed.

Update dependents

Apko is used as a library in Melange, wolfictl, and terraform-provider-apko, among others.

When you cut a release of Apko, particularly when it's to update a vulnerable dependency, you'll probably also want to pick up those changes in Apko's dependents.

Minor releases

Occasionally there are large or breaking changes to Apko that we want to highlight with a new minor release. A minor release should be cut shortly after a breaking change is made, so that regular patch releases don't release breaking changes.

The process for cutting a release is exactly the same as above, except that you should pick a new minor version.

For example, if the latest version is v0.11.5, create a minor release v0.12.0.

Release terraform-provider-apko

For consistency, we prefer to keep minor releases of Apko in-line with minor releases of the Terraform provider.

This means that when you cut v0.12.0, we should also cut a release of tf-apko to v0.12.0.

We don't bother trying to keep patch releases in-sync between these repos, so you don't have to do this on every new patch release.