Skip to content

INSTALLING.md installs the current release, and releasing now updates it - #26

Merged
avison9 merged 1 commit into
mainfrom
docs/installing-current-version
Nov 14, 2026
Merged

avison9 merged 1 commit into
mainfrom
docs/installing-current-version

Conversation

@avison9

@avison9 avison9 commented Nov 14, 2026

Copy link
Copy Markdown
Owner

What changes

  • INSTALLING.md: the release-archive examples for macOS (VERSION=), Linux (VERSION=) and Windows ($Version =), and the Action pin example (version:), go from 0.1.0 to 0.4.0. 0.1.0 is four releases behind and has no --base, --disable or cdclint:ignore.
  • RELEASING.md: a new step after each release updates those lines and re-records docs/demo.tape, so they don't go stale again.

Verified

  • All six v0.4.0 archive URLs the examples build return 200: darwin, linux and windows, each on amd64 and arm64.
  • I ran the Linux snippet, as written (minus sudo), in a clean Debian container. It prints cdclint 0.4.0.

Rejected

Resolving the latest version at install time through the GitHub API. It adds a network call and a JSON parse to a snippet people read before running it. A pinned version is also what a reader can check against checksums.txt.

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.
@avison9 avison9 self-assigned this Nov 14, 2026
@avison9
avison9 merged commit 557b0b8 into main Nov 14, 2026
2 checks passed
@avison9
avison9 deleted the docs/installing-current-version branch November 14, 2026 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant