Skip to content

docs: getting started — drop image version pins - #121

Merged
cherusk merged 1 commit into
mainfrom
docs/unpin-versions
Sep 6, 2026
Merged

docs: getting started — drop image version pins#121
cherusk merged 1 commit into
mainfrom
docs/unpin-versions

Conversation

@godon-robot

@godon-robot godon-robot Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Reworked per review: BNF-style <version> placeholders instead of untagged references.

The walkthrough had pinned godon-bench-generic:0.2.1 — verified two releases stale on GHCR (0.3.0 + latest current); the pin rots by design. Both walkthrough images now carry an explicit placeholder with a one-line hint at each site:

  • ghcr.io/godon-dev/godon-bench-generic:<version> — with an in-block comment: a released tag, or drop :<version> to track the current release
  • ghcr.io/godon-dev/godon-cli:<version> — same hint in the prose line above the command

Properties: nothing to maintain on release day (no literal version in the file), the version choice stays visible to the reader, and the hint teaches the zero-thought path (drop the tag = latest; verified both packages carry latest).

Deliberately kept: configVersion: "0.3" — the breeder config schema, part of a valid config, not an image pin. setup.md needed nothing: the OCI helm install already runs without --version; tool minimums (kind v0.20+, Helm 3.8+, K8s 1.20+) are prerequisites, not godon pins.

The walkthrough pinned godon-bench-generic:0.2.1 (two releases
stale — the pin rots). Image references now carry a BNF-style
<version> placeholder with a one-line hint at each site: a released
tag of the reader's choosing, or drop the tag to track the current
release (latest verified present on ghcr for both images). Nothing
to maintain on release day; the version choice stays visible.
configVersion stays: it is the config schema, not an image pin.

Co-authored-by: cherusk <10729954+cherusk@users.noreply.github.com>
@godon-robot
godon-robot Bot force-pushed the docs/unpin-versions branch from 41433cb to 9ad3116 Compare September 6, 2026 08:25
@cherusk
cherusk merged commit 31f3859 into main Sep 6, 2026
2 checks passed
@cherusk
cherusk deleted the docs/unpin-versions branch September 6, 2026 08:26
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