From 13ed8f8887f67d881596ecdb730ec1d367708026 Mon Sep 17 00:00:00 2001 From: avison9 Date: Sat, 14 Nov 2026 11:52:53 +0100 Subject: [PATCH] INSTALLING.md installs the current release, and releasing now updates it The release-archive examples for macOS, Linux and Windows, and the action's version pin example, still said 0.1.0. That is four releases behind: copying them installed a cdclint without --base, --disable or cdclint:ignore, which every later section of the README assumes. They now say 0.4.0, and all six archive URLs they build resolve. RELEASING.md gains the step that was missing: after the run, bring INSTALLING.md's version lines and docs/demo.tape (the README recording) up to the new tag. Rejected: resolving the latest version at install time through the GitHub API. It adds a network call and a JSON parse to a snippet meant to be read before it is run, and a pinned version is what a reader can check against checksums.txt. --- INSTALLING.md | 8 ++++---- RELEASING.md | 11 +++++++++++ 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/INSTALLING.md b/INSTALLING.md index ceaf8ee..5202458 100644 --- a/INSTALLING.md +++ b/INSTALLING.md @@ -36,7 +36,7 @@ first run; a formula build is never quarantined. **Release archive**, without Homebrew: ``` -VERSION=0.1.0 +VERSION=0.4.0 ARCH=$(uname -m | sed 's/x86_64/amd64/; s/aarch64/arm64/') curl -sSLO "https://github.com/avison9/cdclint/releases/download/v$VERSION/cdclint_${VERSION}_darwin_${ARCH}.tar.gz" tar -xzf "cdclint_${VERSION}_darwin_${ARCH}.tar.gz" cdclint @@ -63,7 +63,7 @@ brew install --cask avison9/tap/cdclint **Release archive** (any distribution, no package manager needed): ``` -VERSION=0.1.0 +VERSION=0.4.0 ARCH=$(uname -m | sed 's/x86_64/amd64/; s/aarch64/arm64/') curl -sSLO "https://github.com/avison9/cdclint/releases/download/v$VERSION/cdclint_${VERSION}_linux_${ARCH}.tar.gz" tar -xzf "cdclint_${VERSION}_linux_${ARCH}.tar.gz" cdclint @@ -81,7 +81,7 @@ fleet needs them; goreleaser can produce both. **Release archive** (PowerShell): ```powershell -$Version = "0.1.0" +$Version = "0.4.0" $Arch = if ($env:PROCESSOR_ARCHITECTURE -eq "ARM64") { "arm64" } else { "amd64" } $Dir = "$env:LOCALAPPDATA\Programs\cdclint" New-Item -ItemType Directory -Force $Dir | Out-Null @@ -127,7 +127,7 @@ verifies its checksum: sink: analytics/schema ``` -Pin a version with `version: v0.1.0` if you want to control upgrades. +Pin a version with `version: v0.4.0` if you want to control upgrades. ## Docker diff --git a/RELEASING.md b/RELEASING.md index 5c546ad..06e15af 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -44,6 +44,17 @@ Check the run, then check the places a user meets it: the Release page, `brew install --cask avison9/tap/cdclint` (the binary) on a Mac or Linux box, and a workflow using the action. +Then bring the docs that name a version up to the new tag, in one pull +request: + +- `INSTALLING.md`: the three release-archive examples (`VERSION=` twice, + `$Version =` once) and the `version:` pin example. They stayed at 0.1.0 + through four releases, so the copy-paste path installed a version without + `--base`, `--disable` or `cdclint:ignore`. +- `docs/demo.tape`: change its version and re-record it with the two + commands in its header, so the README's recording downloads the release + the README describes. + ## Trying the build without releasing ```