Skip to content

docs: tagging v0.1.0 falsified a README sentence; fix it and point embedders at it - #784

Merged
tannevaled merged 1 commit into
mainfrom
wave62-readme-v010
Oct 4, 2026
Merged

tannevaled merged 1 commit into
mainfrom
wave62-readme-v010

Conversation

@tannevaled

Copy link
Copy Markdown
Contributor

Publishing v0.1.0 falsified a sentence in this README, and I published it, so it gets corrected in the same breath.

The stale claim

There are no version tags yet, so `@latest` resolves to the tip of `main`.

Measured, not reasoned:

$ go list -m github.com/go-embedded-ruby/ruby@latest
github.com/go-embedded-ruby/ruby v0.1.0

Worth being precise about what actually changed, because it is not yet visible in the output: v0.1.0 is the tip of main right now (both are bc97c16), so the sentence's effect is accidentally still correct while its mechanism is wrong. It becomes wrong in effect at the next merge.

That is the shape of claim that rots silently — nobody re-reads an install note on the day it stops being true. The replacement describes the mechanism and tells a reader who wants unreleased work to ask for @main explicitly.

Two additions, both where a reader is already looking

A release badge beside the others, so the current version is visible without leaving the page.

A go get ...@v0.1.0 line in the embedding section, which is where someone deciding to depend on this is already reading. It says the module had no tags before, that v0.x carries no API promise, and — the part worth the line —

read the release notes, which list the open security issues rather than leaving them to be discovered.

An embedding API whose first release ships with six known security issues should say so where the dependency is chosen, not only in the notes. The notes themselves open with "Run is not a sandbox. Do not pass untrusted Ruby to it."

Verified

The README tests pass. TestReadmeConformanceCountMatchesTheBaseline scans the whole file for bold thousands-separated numbers, and the new text adds none for it to judge — v0.1.0 is not one.

ok  	github.com/go-embedded-ruby/ruby	1.205s

🤖 Generated with Claude Code

…bedders at it

The install note said:

    There are no version tags yet, so `@latest` resolves to the tip of `main`.

That was true until an hour ago. Publishing v0.1.0 made it false, and I made it
false, so it gets corrected in the same breath. Measured rather than reasoned:

    $ go list -m github.com/go-embedded-ruby/ruby@latest
    github.com/go-embedded-ruby/ruby v0.1.0

Worth being precise about what changed, because it is not yet visible in the
output: v0.1.0 *is* the tip of main right now (both are bc97c16), so the
sentence's effect is accidentally still right while its mechanism is wrong. It
becomes wrong in effect at the next merge, which is exactly the kind of claim
that rots silently -- nobody re-reads an install note the day it stops being
true. The replacement describes the mechanism and tells a reader who wants
unreleased work to ask for `@main`.

Two additions in the same pass, both about the thing a reader of this file is
most likely to want next:

A release badge beside the others, so the current version is visible without
leaving the page.

And a `go get ...@v0.1.0` line in the embedding section, where someone deciding
to depend on this is already reading. It says the module had no tags before,
that v0.x carries no API promise, and -- the part worth the line -- that the
release notes list the open security issues rather than leaving them to be
discovered. An embedding API whose first release ships with six known security
issues should say so where the dependency is chosen, not only in the notes.

The README tests pass; the conformance-count test reads the whole file and the
new text adds no thousands-separated number for it to judge.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@tannevaled
tannevaled merged commit 815f7bb into main Oct 4, 2026
9 checks passed
@tannevaled
tannevaled deleted the wave62-readme-v010 branch October 4, 2026 22:51
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