From 5876287c4aaa130661d06f13734102a746b6f129 Mon Sep 17 00:00:00 2001 From: tannevaled Date: Sun, 4 Oct 2026 23:27:58 +0200 Subject: [PATCH] docs: tagging v0.1.0 falsified a README sentence; fix it and point embedders 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 --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 345b328e..e41c54ef 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![Docs](https://img.shields.io/badge/docs-mkdocs--material-9B1C2E)](https://go-embedded-ruby.github.io/docs/) [![License](https://img.shields.io/badge/license-BSD--3--Clause-blue)](LICENSE) [![Go](https://img.shields.io/badge/go-1.26.4%2B-00ADD8)](https://go.dev/dl/) +[![Release](https://img.shields.io/badge/release-v0.1.0-blue)](https://github.com/go-embedded-ruby/ruby/releases/tag/v0.1.0) [![ruby/spec](https://img.shields.io/badge/ruby%2Fspec-23%2C481%20examples%20passing-1a7f37)](#runtime-conformance--rubyspec) **A Ruby interpreter written in pure Go, with cgo disabled** — so you can embed it @@ -700,7 +701,9 @@ hello from rbgo ``` (The first run compiles the interpreter, which takes a while and produces a large -binary. There are no version tags yet, so `@latest` resolves to the tip of `main`.) +binary. `@latest` now resolves to the newest **release tag** rather than the tip +of `main` — `v0.1.0` as of this writing — so pass `@main` explicitly if you want +unreleased work.) ## Quick start @@ -763,6 +766,15 @@ func Run(src string, out io.Writer) error output to `out`. Everything else in this repository is under `internal/`, so this is the whole embedding surface today. +```console +$ go get github.com/go-embedded-ruby/ruby@v0.1.0 +``` + +`v0.1.0` is the first tagged release; before it the module was consumable only by +pseudo-version. It is a `v0.x`, so the API carries no compatibility promise yet — +pin the version rather than tracking `@latest`, and read the release notes, which +list the open security issues rather than leaving them to be discovered. + ```go package main