Skip to content

docs(readme): name no latest version in the release note, install note and hosted-server line - #155

Merged
luisleo526 merged 3 commits into
mainfrom
docs/surfaces2-readme-version
Sep 30, 2026
Merged

luisleo526 merged 3 commits into
mainfrom
docs/surfaces2-readme-version

Conversation

@luisleo526

@luisleo526 luisleo526 commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Why

PyPI shows each release's README as its package description. The pineforge-codegen 1.0.0 upload (2026-09-30T04:08Z) carries the README of the v1.0.0 tag, which still says "The latest release is 0.10.4" and "This installs the latest release, 0.10.4" (checked in https://pypi.org/pypi/pineforge-codegen/json today). main already names 1.0.0 as the latest (#154), but that sentence goes stale the same way at the next release unless the README is edited before the tag.

What changes (README only)

  • Releases and this README: says the README ships as the PyPI description of each release and describes 1.0.0 (2026-09-30) and what changed since 0.10.4. It no longer calls any version the latest. PyPI's release history lists every release; the changelog covers 1.0.0 on and links earlier notes; npm has the releases from 0.7.0 on. The source-install sentence now points at VERSION, which the release workflow writes.
  • Install: "This installs the latest release." (no number).
  • Hosted-server line: "Both are built on the pineforge-release image, which ships a released codegen and engine pair; their engine_info tool reports the image's version" instead of naming the pair. Both servers' engine_info report 1.0.0 today (hosted: checked on mcp.pineforge.dev; the backtest-mcp image v0.9.32 is built on pineforge-release 1.0.0).
  • The release-lane comment asks, before a tag, for the new Engine pairing row and an update of every line that names 1.0.0 / v1.0.0 as the current release or pair (it names the known ones: this section, the baseline paragraph, the engine src/source/ link, the clone command and its output, "This section describes …", the timing note) and of the "on main" markers, because PyPI shows the README as it is at the tag; lines saying what changed in 1.0.0 stay. The Install note and the hosted-server line name no version.
  • The opening paragraph drops "no engine errors": the engine README at 6b45f510, which gives that baseline's figures, does not state it.

Unchanged on purpose: the Engine pairing table and the 0.10.4 upgrade notes, which state versioned facts.

Checked against

  • PyPI: info.version 1.0.0; releases include 1.0.0 and 1.0.0rc1.
  • Tag v1.0.0 (GitHub release, 2026-09-30); VERSION on main: 1.0.0.
  • npm @pineforge/codegen-pyodide: latest 1.0.0, versions 0.7.0 to 1.0.0 (its own README, npm/README.md, is not this file); PyPI also has 0.6.5.
  • CHANGELOG.md: sections for 1.0.0 and 1.0.0-rc.1; "The notes of 0.10.4 and earlier releases are on the GitHub releases page".

README only: no Python or C++ changed, so the engine-enabled suite was not run for it; CI (gate, pytest 3.11-3.14) runs on this pull request.

When it shows on PyPI

PyPI keeps the 1.0.0 description as uploaded. This README reaches PyPI with the next codegen release, which release.yml builds from main.

🤖 Generated with Claude Code

luisleo526 and others added 3 commits October 1, 2026 06:47
…e and hosted-server line

PyPI shows each release's README as its description. The 1.0.0 upload
(2026-09-30) carries the README of the v1.0.0 tag, which still said
"The latest release is 0.10.4". main now says 1.0.0 is the latest
(#154), which the next release would make stale the same way. The
release section, the Install note and the hosted-server line now name
no latest version; the PyPI release history and the changelog list the
releases. The Engine pairing table and the 0.10.4 upgrade notes keep
their version-specific rows.

Checked: PyPI pineforge-codegen info.version 1.0.0 (uploaded
2026-09-30T04:08Z), tag v1.0.0, VERSION 1.0.0, npm
@pineforge/codegen-pyodide latest 1.0.0.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
The note claimed the release section could not go stale, but it still
names 1.0.0, and the clone command, its example output, the engine
src/source link and "This section describes" also name the release pair.
The note now lists them and says why they must change before the tag
(PyPI shows the README as it is at the tag). The section also says the
changelog covers 1.0.0 on, with earlier notes linked, and that npm has
the releases from 0.7.0 on (PyPI also has 0.6.x).

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
…; drop "no engine errors"

The release-lane note listed some of the lines that name 1.0.0 as the
current release or pair and missed others (the baseline paragraph, the
timing note, the engine v1.0.0 mentions near the end). It now asks for
every such line, and keeps lines saying what changed in 1.0.0.

The opening paragraph said the baseline had "no engine errors"; the
engine README at 6b45f510, which gives that baseline's figures, does not
state it, so it is dropped.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
@luisleo526
luisleo526 merged commit 01b4ee3 into main Sep 30, 2026
9 checks passed
@luisleo526
luisleo526 deleted the docs/surfaces2-readme-version branch October 5, 2026 02:39
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