Skip to content

docs: make README, CHANGELOG and docs true of the 1.0.0 release - #154

Merged
luisleo526 merged 1 commit into
mainfrom
docs/post-1.0
Sep 30, 2026
Merged

luisleo526 merged 1 commit into
mainfrom
docs/post-1.0

Conversation

@luisleo526

Copy link
Copy Markdown
Contributor

1.0.0 was released on 2026-09-30. It is on PyPI as pineforge-codegen==1.0.0 and on npm latest; the GitHub tag v1.0.0 (5bf595b) is a VERSION-only commit on main 121b3e6. Its pair is engine v1.0.0. The README still described "main, which is ahead of the latest release and not yet released", with 0.10.4 as the latest release, and the CHANGELOG still read "1.0.0 — Unreleased". This PR makes those true of the release. Docs only: README, CHANGELOG, CONTRIBUTING, AGENTS.md, CLAUDE.md, docs/PUBLIC_CONTRACT.md and docs/pine-cap-activation.md. No code, test, workflow, metadata or VERSION change.

What changed

  • README:
    • It describes 1.0.0, the latest release.
    • The 0.10.4 differences stay, as an "Upgrading from 0.10.4" note.
    • The "on main" markers now say 1.0.0, "since 1.0.0" or "new in 1.0.0", each re-checked by running 1.0.0 and 0.10.4.
    • The install note says pip install gives 1.0.0.
    • The pairing table reads: 1.0.0 ↔ engine v1.0.0 (image 1.0.0); 0.10.4 ↔ v0.13.1 (image 0.1.25, the last 0.x pair).
    • The tutorial clones engine --branch v1.0.0.
    • Parity is scoped to the 2026-09-29 baseline. The release changed no grade.
  • CHANGELOG: ## 1.0.0 — 2026-09-30 with a true intro. The file's policy asks for one section per released version, so there is also a ## 1.0.0-rc.1 — 2026-09-30 section; 1.0.0 changed only VERSION after rc.1.
  • CONTRIBUTING / AGENTS.md / CLAUDE.md: the latest release is codegen 1.0.0 with engine v1.0.0. The 0.x pairing is kept as history.
  • PUBLIC_CONTRACT / pine-cap-activation: these describe 1.0.0 with engine v1.0.0, not "main with engine main".

Claim → source

Claim Source
PyPI 1.0.0 and 1.0.0rc1; npm latest 1.0.0 and next 1.0.0-rc.1 PyPI JSON; npm view @pineforge/codegen-pyodide dist-tags
A source install of v1.0.0 or main reports 1.0.0 hatch reads VERSION (pyproject.toml); VERSION@5bf595b = 1.0.0; pip install of git archive v1.0.0
Upgrade-note differences (libraries, diagnostics, located syntax errors, limits, request.financial, imports) transpile() / transpile_full() run under 1.0.0 and 0.10.4
0.10.4's C++ does not compile against engine v1.0.0; 1.0.0's needs pine_strategy_host.hpp, which v0.13.1 lacks compile run against a v1.0.0 clone; git ls-tree at both engine tags
The tutorial output block, and the 13 trades with the old sizing re-run with 1.0.0 + engine v1.0.0 and with 0.10.4 + v0.13.1
Codegen 1.0.0 has the code of 70c2b4a; engine v1.0.0 includes 35db01c8; the releases changed no grade git diff 70c2b4a v1.0.0 -- pineforge_codegen (docstrings only); merge-base --is-ancestor; release facts
Image tags 1.0.0 and 0.1.25 ghcr: sha-829ff99,engine1.0.0-codegen1.0.0,1.0,1.0.0,latest and sha-7bf8275,0.1.25,engine0.13.1-codegen0.10.4,0.1
rc.1 → 1.0.0 changed only VERSION git diff --stat 27bf686 5bf595b

Checks

  • pytest, run as CI runs it with the engine disabled: 2697 passed, 1702 skipped, 0 failed. No test reads these files.
  • tomllib parses pyproject.toml; both package.json files are unchanged. python -m build and twine check --strict pass (executor run).
  • All 50 URLs in the touched files return 200 (executor run).

Not in this PR

The PyPI project page for 1.0.0 (and 1.0.0rc1) shows the README as it was tagged, which still says "0.10.4 … not yet released". PyPI descriptions can't be edited after upload, so the next release fixes that page.

🤖 Generated with Claude Code

1.0.0 is released (PyPI pineforge-codegen 1.0.0, npm latest 1.0.0, GitHub
Latest v1.0.0 = 5bf595b, a VERSION-only commit on 121b3e6), paired with
engine v1.0.0. What became true:

- README describes 1.0.0, the latest release, instead of "main, ahead of
  0.10.4 and not yet released". The 0.10.4 differences stay as an
  "Upgrading from 0.10.4" note; "on `main`" markers become 1.0.0 /
  "since 1.0.0" / "new in 1.0.0", each re-checked against 1.0.0 (installed
  from the v1.0.0 tree) and 0.10.4 (from PyPI).
- A source install of v1.0.0 (or of main) reports 1.0.0 (hatch reads
  VERSION), not 0.10.4.
- Install note: pip installs 1.0.0.
- Engine pairing table: 0.10.4 <-> v0.13.1 (hub 0.1.25) is the last 0.x
  pair; 1.0.0 <-> engine v1.0.0 (pineforge-release image 1.0.0). Engine
  v1.0.0 has pineforge/source/pine_strategy_host.hpp; 0.10.4's C++ fails to
  compile against it (script_has_strategy_close_ and other members gone).
- Tutorial: clone engine --branch v1.0.0; codegen 1.0.0 with engine v1.0.0
  prints the same 9 trades as before, and declaring the old sizing books
  the same 13 trades as 0.10.4 with engine v0.13.1 (all three runs redone).
- Hosted MCP and pineforge-backtest-mcp run the 1.0.0 pair (hosted
  engine_info 1.0.0; backtest-mcp:latest = v0.9.32 FROM
  pineforge-release:1.0.0), not codegen 0.10.4 with engine v0.13.1.
- Parity baseline and limits measurements are scoped to the commits they
  were taken at (codegen 70c2b4a, same code as 1.0.0; engine 35db01c8,
  which v1.0.0 includes and whose corpus pin v1.0.0 shares); the release
  changed no grade.
- CHANGELOG: "1.0.0 — Unreleased" becomes "1.0.0 — 2026-09-30" with a true
  intro (#153 named as the documentation update); the policy's
  section-per-prerelease rule adds "1.0.0-rc.1 — 2026-09-30" (1.0.0
  changed only VERSION after 27bf686).
- CONTRIBUTING, AGENTS.md, CLAUDE.md, PUBLIC_CONTRACT, pine-cap-activation:
  the latest release is codegen 1.0.0 with engine v1.0.0; engine v1.0.0
  (not "engine main") defines the adapter macros, lacks
  script_has_strategy_close_ and uses engine_script_run_v19.
- The 0.x pair names the hub image by its tag, 0.1.25 (v0.1.25 is the
  GitHub release tag; ghcr has 0.1.25, engine0.13.1-codegen0.10.4, 0.1).
  CONTRIBUTING no longer pins "(1.0.0)" in its README rule, and the
  README's release-lane comment lists the "latest release pair" line.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
@luisleo526
luisleo526 marked this pull request as ready for review September 30, 2026 06:16
@luisleo526
luisleo526 merged commit 5d2113f into main Sep 30, 2026
9 checks passed
luisleo526 added a commit that referenced this pull request Sep 30, 2026
…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]>
luisleo526 added a commit that referenced this pull request Sep 30, 2026
…e and hosted-server line (#155)

* docs(readme): name no latest version in the release note, install note 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]>

* docs(readme): list every per-release line in the release-lane note

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]>

* docs(readme): the lane note covers every line naming the release pair; 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]>

---------

Co-authored-by: Claude Opus 5.5 (1M context) <[email protected]>
@luisleo526
luisleo526 deleted the docs/post-1.0 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