From e8ccd038bcb6602c7cbf95bc2f74e303d72194b8 Mon Sep 17 00:00:00 2001 From: Imani Manyara Date: Sun, 8 Nov 2026 04:46:36 -0500 Subject: [PATCH] Document the disabled Release workflow Tags v0.1.0 through v0.7.0 carry a release.yml that a manual dispatch runs with no confirmation step. The workflow is disabled in Actions while binary releases are on hold; the release guide now turns it on for an approved run only. --- CHANGELOG.md | 5 +++++ docs/release.md | 16 ++++++++++++++-- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ac1e7bd..3990831 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,11 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). release download fails. ### Changed +- **The `Release` workflow is disabled in Actions while binary releases are on + hold.** The tags `v0.1.0` through `v0.7.0` carry an older `release.yml` that a + manual dispatch would run with no confirmation step, and a disabled workflow + runs on no ref. `docs/release.md` gives the enable, dispatch and disable + commands for an approved release. - **Binary releases are on hold; the release workflow runs only on a confirmed manual dispatch.** A tag push no longer starts GoReleaser. A release is dispatched on a `v[0-9]*` tag with `-f confirm=release-go` diff --git a/docs/release.md b/docs/release.md index a681cf4..7708ba4 100644 --- a/docs/release.md +++ b/docs/release.md @@ -20,11 +20,14 @@ source ([installation](installation.md#install)). ``` Pushing a tag publishes nothing: no workflow starts on a tag push. -4. Only when the owner has approved a binary release for this version, dispatch - the `Release` workflow (`.github/workflows/release.yml`) on the tag: +4. Only when the owner has approved a binary release for this version, turn the + `Release` workflow (`.github/workflows/release.yml`) on, dispatch it on the + tag, and turn it off again once the run has started: ```bash + gh workflow enable release.yml --repo simtabi/vigil gh workflow run release.yml --repo simtabi/vigil --ref vX.Y.Z -f confirm=release-go + gh workflow disable release.yml --repo simtabi/vigil ``` `vX.Y.Z` must be a real tag already on GitHub. The command publishes for real @@ -32,6 +35,15 @@ source ([installation](installation.md#install)). version. The first step refuses to run without `confirm=release-go`, or on any ref that is not a `v[0-9]*` tag, before anything is built. +**The `Release` workflow is disabled in Actions while binary releases are on +hold** (since 2026-11-08). A dispatch runs the copy of `release.yml` that the tag +carries, and the tags `v0.1.0` through `v0.7.0` carry an older one that accepts +a manual dispatch and publishes with no confirmation step. A tag cannot be +changed, so the workflow's enabled state is the only control that covers them: +a disabled workflow runs on no ref. Check it with +`gh workflow list --repo simtabi/vigil --all`, which shows `Release` as +`disabled_manually`. + ## Repository layout The Go module lives in **`src/`** (`github.com/simtabi/vigil/src`): `src/go.mod`,