extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-02-26 23:21:56 +01:00
Code Issues Packages Projects Releases Wiki Activity
c25325ea7f
zrok/RELEASING.md
Kenneth Bingham 013956e087
handle semver pre-release package filename variants
2025-02-13 17:29:58 -05:00

2.3 KiB
Raw Blame History

Releasing zrok

Semantic Versioning

This project uses semantic versioning. See here for more information.

Release tags like v3.2.1 are eligible for promotion to stable status in GitHub and downstream distribution channels.

Pre-release tags like v3.2.1-rc1 (with a semver hyphenated pre-release suffix) are published in GitHub as pre-releases, and are blocked from promotion to downstream distribution channels if they are marked "stable" by mistake and the GitHub "released" event fires.

Pre-release version strings must contain exactly one hyphen, and may not contain an underscore.

How to Trigger Release Automation

Note

Each trigger is outlined separately, but some may occur simultaneously, e.g., when a draft release is published as stable rather than first publishing it as a pre-release, or a pre-release is promoted to stable and marked as latest at the same time.

  1. Push a tag to GitHub like v*.*.* to trigger the pre-release workflow. Wait for this workflow to complete before marking the release stable (isPrerelease: false).
    1. Linux packages are uploaded to Artifactory as pre-releases.
    2. Docker images are uploaded to Docker Hub as pre-releases.
    3. A release is drafted in GitHub.
  2. Edit the draft and publish the release as a pre-release (isPrerelease: true).
    1. The one-time GitHub "published" event fires, and binaries are available in GitHub.
  3. If the release does not have a pre-release suffix, mark it as stable by un-checking (isPrerelease: false).
    1. The one-time GitHub "released" event fires.
    2. Linux packages are promoted to "stable" in Artifactory.
    3. Docker images are promoted to :latest in Docker Hub.
    4. Homebrew formulae are built and released.
    5. Python wheels are built and released to PyPi.
    6. Node.js packages are built and released to NPM.
  4. Edit the stable release to mark it as latest.
    1. https://docs.zrok.io/docs/guides/install/ always serves the "latest" stable version via GitHub binary download URLs.

Rolling Back Downstreams

The concepts, tools, and procedures for managing existing downstream artifacts in Artifactory and Docker Hub are identical for zrok and ziti. Here's the RELEASING.md document for ziti.