Skip to content

Commit 4c78f39

Browse files
luisleo526claude
andauthored
docs: the 1.5.0 release (changelog, current pair, HPO note) (#374)
Squash of #374 (3 docs commits on 2394ba2, tree 776a3cb). The CHANGELOG entry is dated 2026-10-12, the tag date; the first commit's "2026-10-13" below is superseded. The three commit messages follow verbatim, so their doc-revert namings are kept. docs: prepare the 1.5.0 release (changelog, current pair) Date the CHANGELOG's 1.5.0 entry 2026-10-13 and give it the release link line naming the paired pineforge-codegen 1.5.0, keeping the recorded-outputs and call-scoped-report content unchanged. Add the release's other user-visible changes: the test inputs and strategy scripts moved to a private repository, where a test that needs one skips with the pinned message naming the missing file; the LEGAL.md "Data not distributed" section; and the private-fixture overlay the maintainers run the verification with. README: the current-release block, the codegen command-block pointer, the C ABI counts line and a new v1.5.0 Releases bullet now name 1.5.0; the v1.4.0 descriptions, scoreboard and benchmark measurements stay untouched. The current-release block's 1.4.0 sentence from 5a1ad3a ("The release notes cover typed and unresolved provenance, coded failures, checked settings, adapter fixes and chart-clock live input") is replaced on purpose by the 1.5.0 sentence that lists what 1.5.0 covers; that 1.4.0 summary stays in the Releases list (the v1.4.0 bullet) and in CHANGELOG.md's 1.4.0 entry. docs/pages/public-contract.md: the 1.5.0 paragraph follows the 1.4.0 one and the same-version pairing line now says 1.5.0. Scoreboard and benchmark numbers are untouched; no file outside these three changes. docs: 1.5.0 is released: status words, HPO note The CHANGELOG's 1.5.0 entry gains its HPO bullet: pineforge-hpo 0.13.2 pins pineforge-codegen <1.4, and HPO support for codegen 1.4 and 1.5 (enum options as Enum.member tags) comes in pineforge-hpo 0.14.0. Five files that still called 1.5.0, or a 1.5.0 feature, unreleased or targeted for it now read as released once the tag lands: docs/pages/abi-stability.md (the RunFailureCode exception, the symbol-inventory counts line, the recorded-outputs line), docs/pages/index.md (its counts line, matching the README wording), the run-failure page (the outputs and selected-window rows' status, the two 1.5.0 outputs reasons, and the 24 catalog rows that said none was released), docker/README.md (the recorded-outputs section) and docs/outputs.md. Only the status words change; "not part of 1.4.0" stays where it is true history, and no number, claim or other sentence moves. No file outside these six changes. Co-Authored-By: Claude Code <[email protected]> docs: list the new installed header native_calc_point.hpp for 1.5.0 K1 (#369) added include/pineforge/native_calc_point.hpp, installed by the include/pineforge rule in CMakeLists.txt with the other headers. Name it in the 1.5.0 CHANGELOG entry and in the native C++ API list of docs/pages/public-contract.md (new in 1.5.0). Docs only. Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
1 parent 2394ba2 commit 4c78f39

8 files changed

Lines changed: 64 additions & 21 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,15 @@ README's *Releases* section and on the GitHub releases page. From 1.0.0 the
55
version number follows semantic versioning over the surfaces the
66
[public contract](docs/pages/public-contract.md) lists.
77

8-
## 1.5.0 — Unreleased
8+
## 1.5.0 — 2026-10-12
9+
10+
**[1.5.0](https://github.com/pineforge-4pass/pineforge-engine/releases/tag/v1.5.0)**,
11+
paired with [pineforge-codegen 1.5.0](https://github.com/pineforge-4pass/pineforge-codegen-oss/releases/tag/v1.5.0).
12+
This minor release adds recorded outputs and the call-scoped report rule
13+
below, and moves the engine's test inputs and strategy scripts out of this
14+
repository. Regenerate strategy C++ with the matching codegen and relink
15+
against the matching engine headers and archive; replacing the archive alone
16+
does not update a statically linked strategy library.
917

1018
- **Recorded outputs.** A module can record what it computes on each bar
1119
besides its trades: doubles in named slots per bar, doubles kept once per
@@ -48,6 +56,30 @@ version number follows semantic versioning over the surfaces the
4856
`BacktestEngine::fill_report`, so the C and native-module entry points and
4957
the generated `run_backtest` / `run_backtest_full` wrappers all obey it, with
5058
no change to emitted source.
59+
- **The test inputs and strategy scripts moved to a private repository.** The
60+
engine's non-public test inputs — price series, strategy scripts and the
61+
sources generated from them, and some test programs — are no longer in this
62+
repository; the maintainers keep them in a private repository. A test that
63+
needs one skips, naming the missing file with the pinned message
64+
`SKIP private fixtures not present:` followed by that file's path, so a tree
65+
without them still configures and runs the rest of the suite.
66+
- **LEGAL.md, "Data not distributed".** LEGAL.md now carries a *Data not
67+
distributed* section — pointed to from its submodule paragraph — recording
68+
that some test inputs are not distributed in this repository or in its
69+
submodules, and that the engine does not depend on them: it builds without
70+
them, and the public corpus and the kernel suites run without them.
71+
- **A private-fixture overlay for the maintainers' verification.** With the
72+
private inputs overlaid back into the tree — signalled by
73+
`PINEFORGE_PRIVATE_FIXTURES` — the verification requires every pinned row to
74+
run: a row that skips there fails the run. Without the overlay, those rows
75+
skip in public runs and the row floors account for them.
76+
- **A new installed header, `<pineforge/native_calc_point.hpp>`.** It holds the
77+
plain-data vocabulary of the calculation points of a driving-event schedule:
78+
the driving-event kinds (`EventKind`, `Event`), the cadence bits an instance
79+
computes on, and the phase and finality of one planned calculation. The
80+
headers install with the others (CMakeLists.txt, the `install(DIRECTORY
81+
include/pineforge ...)` rule); it is part of the native C++ host surface.
82+
- **HPO.** pineforge-hpo 0.13.2 pins pineforge-codegen <1.4; HPO support for codegen 1.4 and 1.5 (enum options as Enum.member tags) comes in pineforge-hpo 0.14.0.
5183

5284
[#361]: https://github.com/pineforge-4pass/pineforge-engine/pull/361
5385

‎README.md‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,16 @@ The separate PineForge compiler, [`pineforge-codegen`](https://github.com/pinefo
3636
- **Yours to embed.** 145 `PF_API` declarations across five installed headers — `pineforge.h`'s 94 (74 of the 80 runtime exports, the other six being declared in `execution_observer.h` and `selected_window.h`, three each, and up to 20 per-strategy functions a generated module defines), `native_c_api.h`'s 43 native-host declarations and `selected_window_plan.h`'s two planner declarations — an ABI that is append-only within a major version from 1.0 on. Call it from C, Python, Rust, Go, Node, Julia — or let an AI agent drive it over MCP.
3737

3838
Recorded outputs and their additional API declarations described here are
39-
unreleased work targeted for **1.5.0**; they are not part of 1.4.0.
39+
part of **1.5.0**.
4040

41-
**[1.4.0](https://github.com/pineforge-4pass/pineforge-engine/releases/tag/v1.4.0)
42-
was released on 2026-10-08**, paired with
43-
[pineforge-codegen 1.4.0](https://github.com/pineforge-4pass/pineforge-codegen-oss/releases/tag/v1.4.0).
44-
The [release notes](CHANGELOG.md#140--2026-10-08) cover typed and unresolved
45-
provenance, coded failures, checked settings, adapter fixes and chart-clock
46-
live input. For the 1.4.0 pair, regenerate strategy C++ and
47-
relink against that pair's headers and archive. Published 1.3.0 download and
48-
installation examples below remain pinned to that earlier pair.
41+
**[1.5.0](https://github.com/pineforge-4pass/pineforge-engine/releases/tag/v1.5.0)
42+
was released on 2026-10-12**, paired with
43+
[pineforge-codegen 1.5.0](https://github.com/pineforge-4pass/pineforge-codegen-oss/releases/tag/v1.5.0).
44+
The [release notes](CHANGELOG.md#150--2026-10-12) cover recorded outputs, the
45+
call-scoped report rule and the test inputs' move to a private repository.
46+
For the 1.5.0 pair, regenerate strategy C++ and relink against that pair's
47+
headers and archive. Published 1.3.0 download and installation examples below
48+
remain pinned to that earlier pair.
4949

5050
---
5151

@@ -143,7 +143,7 @@ TradingView's execution semantics on top of the kernel; this is the path the
143143
validation scoreboard below measures.
144144
145145
This command block is for the published engine/codegen **1.3.0 pair**.
146-
For 1.4.0, use the matching release tags linked above and regenerate and
146+
For 1.5.0, use the matching release tags linked above and regenerate and
147147
relink against that pair's headers and archive.
148148
149149
```bash
@@ -504,7 +504,7 @@ API, the script ABI epoch and the pairing with codegen — is the
504504
[public contract](docs/pages/public-contract.md); what a 0.x user must act on
505505
is in [CHANGELOG.md](CHANGELOG.md).
506506

507-
The counts below include recorded outputs and describe the unreleased API targeted for 1.5.0; recorded outputs are not part of 1.4.0.
507+
The counts below include recorded outputs and describe the released 1.5.0 API.
508508

509509
A newly generated strategy `.so` exposes 96 compiled-strategy `PF_API` declarations
510510
(80 runtime implementations plus sixteen generated exports) plus 43 native-host
@@ -674,6 +674,7 @@ Documentation: [C ABI reference](https://cdocs.pineforge.dev) · [Getting starte
674674

675675
## Releases
676676

677+
- **[v1.5.0](https://github.com/pineforge-4pass/pineforge-engine/releases/tag/v1.5.0)** (2026-10-12) — recorded outputs: a module can record per-bar doubles in named slots, run-level doubles and events, read through the nine `pf_outputs` runtime exports with coded refusals, off until a caller turns them on and byte-identical when unused; a run's report belongs to the call that began it; the engine's test inputs and strategy scripts moved to a private repository, with tests that need them skipping by name, a LEGAL.md *Data not distributed* note and a maintainers' private-fixture overlay. The C layouts stay at ABI 4, `PF_ABI_VERSION` stays 4 and the new members enter `engine_script_run_v19` without an epoch. Pair with codegen 1.5.0, regenerate and relink. See [CHANGELOG.md](CHANGELOG.md#150--2026-10-12).
677678
- **[v1.4.0](https://github.com/pineforge-4pass/pineforge-engine/releases/tag/v1.4.0)** (2026-10-08) — two additive C failure getters; typed input/override provenance with explicit unresolved reasons and duplicate-title counts; coded failure JSON and checked-setting refusals; Pine exit/fill-location corrections that can change trades, reports and hash values on the affected paths; chart-timeframe live input and final-delivery draining; feed ownership and verification improvements. The C layouts stay at ABI 4, while hash recipes and report content have the disclosed changes. Pair with codegen 1.4.0, regenerate and relink. See [CHANGELOG.md](CHANGELOG.md#140--2026-10-08).
678679
- **v1.3.0** (2026-10-06) — a minor release: `pineforge-live` admits the proven confirmed-bar request shapes and standalone close-only `varip` from the confirmed-bar receipt a strategy generated by pineforge-codegen 1.3.0 exports; Pine adapter parity changes (exit binding at the call, global exits on a held position beside an opposite entry or a same-side add, margin calls at the open after a `process_orders_on_close` close fill, the margin-call schedule, the exact reversal tie, the carried trail, the position view after a close fill, open-marketable exits first). `pineforge.h` is unchanged. No report key changes. The hub image `pineforge-release:1.3.0` carries the pair; regenerate and relink. See [CHANGELOG.md](CHANGELOG.md).
679680
- **v1.2.0** (2026-10-05) — a minor release: a strategy generated by pineforge-codegen 1.2.0 exports a compiled execution-capabilities receipt (`strategy_capabilities_receipt`), from which `pineforge-live` refuses what its close-only stream cannot honour; Pine adapter parity changes (exit children at one point, the trail tolerance, margin, sizing and admission rules, the explicit quantity floor, the script's equity mark, bar fills under `process_orders_on_close`, the session clock across daylight-saving switches), and native runner service operation, cumulative report export and live redelivery. No report key changes. The hub image `pineforge-release:1.2.0` carries the pair; regenerate and relink. See [CHANGELOG.md](CHANGELOG.md).

‎docker/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ docker run --rm \
268268

269269
### Recorded outputs (the harness's `--outputs`)
270270

271-
This section describes unreleased support targeted for **1.5.0**. Released
271+
This section describes support released in **1.5.0**. Released
272272
1.4.0 images do not provide recorded outputs.
273273

274274
A library compiled to record outputs keeps, besides its trades, values per bar,

‎docs/outputs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Recorded outputs
22

3-
Recorded outputs are unreleased, targeted for 1.5.0, and not part of 1.4.0.
3+
Recorded outputs are released in 1.5.0, and not part of 1.4.0.
44

55
A module can record what it computes on each bar besides its trades: values
66
kept per bar, values kept once per run, and events with an optional message.

‎docs/pages/abi-stability.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ From 1.0.0, within one `PINEFORGE_VERSION_MAJOR` (the
1717
- **`extern "C"` functions are append-only.** New functions may be added;
1818
existing ones are never removed or renamed.
1919
- **Enum values** are **stable**. New enumerators may be added; existing
20-
values never change. One exception, unreleased and targeted for 1.5.0:
20+
values never change. One exception, released in 1.5.0:
2121
`RunFailureCode` in the installed C++ header
2222
`include/pineforge/run_failure_codes.hpp` is renumbered, and 36 of the 38
2323
codes released in 1.4.0 get new numeric values (`none` and the first two
@@ -67,7 +67,7 @@ Three layers:
6767

6868
## Symbol inventory
6969

70-
The counts below include recorded outputs and describe the unreleased API targeted for 1.5.0; recorded outputs are not part of 1.4.0.
70+
The counts below include recorded outputs and describe the released 1.5.0 API; recorded outputs are not part of 1.4.0.
7171

7272
A built strategy `.so` exposes 96 compiled-strategy `PF_API` declarations
7373
(80 runtime implementations plus sixteen generated exports) plus 43 native-host
@@ -229,7 +229,7 @@ a run with no symbol data folds nothing new. The C side is append-only -- four
229229
functions, each behind its own `PINEFORGE_HAS_…_V1` probe -- so
230230
`PF_ABI_VERSION` stays 4.
231231

232-
Recorded outputs are unreleased, targeted for 1.5.0, and not part of 1.4.0.
232+
Recorded outputs are released in 1.5.0, and not part of 1.4.0.
233233

234234
Recorded outputs (lane SM-E1, `docs/outputs.md`) adds the recorder to
235235
`BacktestEngine` inside v19, without an epoch: data members outside both

‎docs/pages/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ directly, so a Pine-layer symbol reaching one is a link error.
135135

136136
## API at a glance
137137

138-
The counts below include recorded outputs and describe the unreleased API targeted for 1.5.0; recorded outputs are not part of 1.4.0.
138+
The counts below include recorded outputs and describe the released 1.5.0 API.
139139

140140
The public C surface is **145 `PF_API` declarations** across the five installed headers that declare any:
141141

‎docs/pages/public-contract.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,16 @@ It adds two runtime failure getters and the feature probe
3030
resolution/failure fields. The repository's
3131
[CHANGELOG.md](../../CHANGELOG.md#140--2026-10-08), under
3232
*1.4.0 — 2026-10-08*, inventories the state-hash additions and report migration.
33-
Use the same-version 1.4.0 pair, with regeneration and relinking as below.
33+
34+
1.5.0 followed on 2026-10-12: engine v1.5.0 with pineforge-codegen 1.5.0.
35+
It adds recorded outputs — doubles in named per-bar slots, run-level doubles
36+
and events, through the nine `pf_outputs` runtime exports of
37+
`<pineforge/pineforge.h>`, recorded only when a caller turns them on — and
38+
gives each run's report to the call that began it. The repository's
39+
[CHANGELOG.md](../../CHANGELOG.md#150--2026-10-12), under
40+
*1.5.0 — 2026-10-12*, inventories both and the test inputs' move to a
41+
private repository.
42+
Use the same-version 1.5.0 pair, with regeneration and relinking as below.
3443

3544
## Versions
3645

@@ -135,6 +144,7 @@ the arguments #strategy_get_last_error_args answers (@ref run_failure_codes).
135144
The native C++ API is the kernel's host surface: `<pineforge/native_host.hpp>`,
136145
`<pineforge/native_run_spec.hpp>`, `<pineforge/native_fx_curve.hpp>`,
137146
`<pineforge/native_order.hpp>`, `<pineforge/native_calendar.hpp>`,
147+
`<pineforge/native_calc_point.hpp>` (new in 1.5.0),
138148
`<pineforge/market_driver.hpp>`, `<pineforge/order_action.hpp>`,
139149
`<pineforge/execution.hpp>`, the header-only `<pineforge/native_toolkit.hpp>`
140150
and `<pineforge/native_module.hpp>` (@ref native_engine).

‎docs/pages/run-failure-codes.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ codes it tested the text alone, so a script stopped by an empty
9393

9494
The tables below list the catalog at this tree.
9595

96-
The `outputs_limit` and `outputs_rejected` rows below are unreleased, targeted for 1.5.0, and not part of 1.4.0; so are the 24 selected-window and report-contract rows described [after the tables](#run_failure_codes_selected_window). The other 38 codes retain their released 1.4.0 status. The `strategy_library_incompatible` row counts the two unreleased 1.5.0 outputs reasons, `outputs_api_mismatch` and `outputs_manifest_invalid`, in addition to its six released 1.4.0 reasons.
96+
The `outputs_limit` and `outputs_rejected` rows below are released in 1.5.0, and not part of 1.4.0; so are the 24 selected-window and report-contract rows described [after the tables](#run_failure_codes_selected_window). The other 38 codes retain their released 1.4.0 status. The `strategy_library_incompatible` row counts the two released 1.5.0 outputs reasons, `outputs_api_mismatch` and `outputs_manifest_invalid`, in addition to its six released 1.4.0 reasons.
9797

9898
<!-- BEGIN generated from docker/run_failure_codes.json: python3 scripts/test_gen_run_failure_catalog_diff.py --write-docs-tables -->
9999

@@ -224,7 +224,7 @@ three: `report_post_execution_failed` (the phases after the strategy has
224224
finished), `engine_command_value_invalid` (an invalid command value the engine
225225
derived itself) and `window_pruner_unsupported` (the optimizer's trial pruner).
226226
Their classes, argument kinds and English are the contract's; all are
227-
`retryable: false` and `since: 1.5.0`, and none is released. The registry
227+
`retryable: false` and `since: 1.5.0`, and all are released. The registry
228228
declares them and validates their arguments, which is all this page states
229229
about them: whether a build raises one is the build's own, and a row in the
230230
catalog is not proof that the source paths it names enforce anything.

0 commit comments

Comments
 (0)