Skip to content

Commit 2f2cb62

Browse files
docs: reconcile published release history and unreleased maintenance notes (#149)
* docs: reconcile release history and preserve compatibility records * docs: record accepted migration and contributor maintenance as unreleased
1 parent e349cbf commit 2f2cb62

3 files changed

Lines changed: 338 additions & 4 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 165 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,171 @@
22

33
<!-- Generated from release/changelog.json. Do not edit managed entries. -->
44

5-
## 0.1.0 - Unreleased
5+
## 0.1.13 - Unreleased
6+
7+
### Fixed
8+
9+
- Retain Sunday evening bars that belong to a Monday CME exchange session.
10+
- Apply max_single_weight symmetrically to requested long and short target weights.
11+
- Include futures contract multipliers in the affected simple-cash and sequential buying-power
12+
reservation checks.
13+
- Return positive infinite CAGR when annualizing an extreme short positive-return window
14+
overflows, so EquityCurve.to_dict completes.
15+
- Keep the shared comparison group compatible with Plotly below 7 on Python below 3.15 and
16+
regenerate all isolated lock metadata.
17+
18+
### Documentation
19+
20+
- Correct executor-mode configuration, fill-eligibility descriptions, headroom and whole-share
21+
target rounding. Link the rebalancing guide to the enum, configuration and executor API
22+
reference.
23+
- Make the Zipline migration guide explicit about input and execution assumptions, with a checked
24+
synthetic target-weight example and a link to the tested Diagnostic portfolio-analysis handoff.
25+
- Publish the local contribution guide and issue/PR templates linked to the shared policy,
26+
preserving private security reporting and the verified usage-documentation destination.
27+
28+
### Build and compatibility
29+
30+
- Update the build backend, pinned workflow actions and vulnerable dependency locks while
31+
preserving the frozen comparison framework identities.
32+
- Accept final CPython 3.15 in the canary and describe its steps accurately. Stable support
33+
remains CPython 3.12 through 3.14; no blanket optional-package support for 3.15 is added.
34+
35+
### Compatibility
36+
37+
- Results change in the corrected overnight-session, short-target and futures-cash cases. Target
38+
caps apply before whole unit rounding and do not guarantee a continuous limit on realized
39+
exposure.
40+
- Consumers of raw metric dictionaries must handle non-finite CAGR for extreme short windows.
41+
Versioned result exports retain their documented tagged JSON encoding for non-finite metrics.
42+
43+
### Validation
44+
45+
- Regenerate correctness evidence from frozen inputs and preserve original timing measurements,
46+
using the existing source-certification mechanism for documentation-only source changes.
47+
48+
## 0.1.12 - 2026-09-24
49+
50+
### Changed
51+
52+
- Complete task guides and the verified Book Guide with installed-wheel examples.
53+
54+
### Release notes
55+
56+
- [Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.12).
57+
58+
## 0.1.11 - 2026-09-24
59+
60+
### Changed
61+
62+
- Correct User Guide API examples and explanations of strategy state.
63+
64+
### Release notes
65+
66+
- [Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.11).
67+
68+
## 0.1.10 - 2026-09-24
69+
70+
### Changed
71+
72+
- Add an audited User Guide with task navigation.
73+
74+
### Release notes
75+
76+
- [Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.10).
77+
78+
## 0.1.9 - 2026-09-24
79+
80+
### Changed
81+
82+
- Correct backtest behavior, add guided documentation and refresh the build backend.
83+
84+
### Release notes
85+
86+
- [Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.9).
87+
88+
## 0.1.8 - 2026-09-21
89+
90+
### Changed
91+
92+
- Reconcile time zones before trade enrichment, improve verification of newly published packages,
93+
and complete the closure documentation audit.
94+
95+
### Release notes
96+
97+
- [Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.8).
98+
99+
## 0.1.7 - 2026-09-12
100+
101+
### Changed
102+
103+
- Remove the inert LinearImpact.permanent_fraction parameter and add provenance-preserving source
104+
certification for performance evidence.
105+
106+
### Release notes
107+
108+
- [Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.7).
109+
110+
## 0.1.6 - 2026-09-09
111+
112+
### Changed
113+
114+
- Standardize ecosystem setup and public agent orientation.
115+
116+
### Release notes
117+
118+
- [Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.6).
119+
120+
## 0.1.5 - 2026-09-05
121+
122+
### Changed
123+
124+
- Publish bounded real-strategy comparisons and timing evidence, and authenticate licensed
125+
VectorBT Pro installation through GitHub CLI.
126+
127+
### Release notes
128+
129+
- [Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.5).
130+
131+
## 0.1.4 - 2026-09-03
132+
133+
### Changed
134+
135+
- Use the feed VWAP for VWAP execution and reject unavailable required VWAP prices.
136+
137+
### Release notes
138+
139+
- [Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.4).
140+
141+
## 0.1.3 - 2026-08-12
142+
143+
### Changed
144+
145+
- Update pinned GitHub Actions.
146+
147+
### Release notes
148+
149+
- [Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.3).
150+
151+
## 0.1.2 - 2026-08-11 (tag only)
152+
153+
### Tagged source
154+
155+
- The annotated v0.1.2 tag exists. No matching published release or artifact is currently listed
156+
in the GitHub/PyPI records checked on 2026-10-15. See [tagged
157+
source](https://github.com/ml4t/backtest/tree/v0.1.2).
158+
159+
## 0.1.1 - 2026-08-10
160+
161+
### Changed
162+
163+
- Add per-asset position rules for pre-open execution.
164+
165+
### Release notes
166+
167+
- [Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.1).
168+
169+
## 0.1.0 - 2026-08-09
6170

7171
### Added
8172

‎release/changelog.json‎

Lines changed: 171 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,178 @@
22
"legacy_start": "0.1.0b17",
33
"releases": [
44
{
5-
"version": "0.1.0",
5+
"version": "0.1.13",
66
"date": "Unreleased",
7+
"sections": {
8+
"Fixed": [
9+
"Retain Sunday evening bars that belong to a Monday CME exchange session.",
10+
"Apply max_single_weight symmetrically to requested long and short target weights.",
11+
"Include futures contract multipliers in the affected simple-cash and sequential buying-power reservation checks.",
12+
"Return positive infinite CAGR when annualizing an extreme short positive-return window overflows, so EquityCurve.to_dict completes.",
13+
"Keep the shared comparison group compatible with Plotly below 7 on Python below 3.15 and regenerate all isolated lock metadata."
14+
],
15+
"Documentation": [
16+
"Correct executor-mode configuration, fill-eligibility descriptions, headroom and whole-share target rounding. Link the rebalancing guide to the enum, configuration and executor API reference.",
17+
"Make the Zipline migration guide explicit about input and execution assumptions, with a checked synthetic target-weight example and a link to the tested Diagnostic portfolio-analysis handoff.",
18+
"Publish the local contribution guide and issue/PR templates linked to the shared policy, preserving private security reporting and the verified usage-documentation destination."
19+
],
20+
"Build and compatibility": [
21+
"Update the build backend, pinned workflow actions and vulnerable dependency locks while preserving the frozen comparison framework identities.",
22+
"Accept final CPython 3.15 in the canary and describe its steps accurately. Stable support remains CPython 3.12 through 3.14; no blanket optional-package support for 3.15 is added."
23+
],
24+
"Compatibility": [
25+
"Results change in the corrected overnight-session, short-target and futures-cash cases. Target caps apply before whole unit rounding and do not guarantee a continuous limit on realized exposure.",
26+
"Consumers of raw metric dictionaries must handle non-finite CAGR for extreme short windows. Versioned result exports retain their documented tagged JSON encoding for non-finite metrics."
27+
],
28+
"Validation": [
29+
"Regenerate correctness evidence from frozen inputs and preserve original timing measurements, using the existing source-certification mechanism for documentation-only source changes."
30+
]
31+
}
32+
},
33+
{
34+
"version": "0.1.12",
35+
"date": "2026-09-24",
36+
"sections": {
37+
"Changed": [
38+
"Complete task guides and the verified Book Guide with installed-wheel examples."
39+
],
40+
"Release notes": [
41+
"[Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.12)."
42+
]
43+
}
44+
},
45+
{
46+
"version": "0.1.11",
47+
"date": "2026-09-24",
48+
"sections": {
49+
"Changed": [
50+
"Correct User Guide API examples and explanations of strategy state."
51+
],
52+
"Release notes": [
53+
"[Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.11)."
54+
]
55+
}
56+
},
57+
{
58+
"version": "0.1.10",
59+
"date": "2026-09-24",
60+
"sections": {
61+
"Changed": [
62+
"Add an audited User Guide with task navigation."
63+
],
64+
"Release notes": [
65+
"[Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.10)."
66+
]
67+
}
68+
},
69+
{
70+
"version": "0.1.9",
71+
"date": "2026-09-24",
72+
"sections": {
73+
"Changed": [
74+
"Correct backtest behavior, add guided documentation and refresh the build backend."
75+
],
76+
"Release notes": [
77+
"[Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.9)."
78+
]
79+
}
80+
},
81+
{
82+
"version": "0.1.8",
83+
"date": "2026-09-21",
84+
"sections": {
85+
"Changed": [
86+
"Reconcile time zones before trade enrichment, improve verification of newly published packages, and complete the closure documentation audit."
87+
],
88+
"Release notes": [
89+
"[Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.8)."
90+
]
91+
}
92+
},
93+
{
94+
"version": "0.1.7",
95+
"date": "2026-09-12",
96+
"sections": {
97+
"Changed": [
98+
"Remove the inert LinearImpact.permanent_fraction parameter and add provenance-preserving source certification for performance evidence."
99+
],
100+
"Release notes": [
101+
"[Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.7)."
102+
]
103+
}
104+
},
105+
{
106+
"version": "0.1.6",
107+
"date": "2026-09-09",
108+
"sections": {
109+
"Changed": [
110+
"Standardize ecosystem setup and public agent orientation."
111+
],
112+
"Release notes": [
113+
"[Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.6)."
114+
]
115+
}
116+
},
117+
{
118+
"version": "0.1.5",
119+
"date": "2026-09-05",
120+
"sections": {
121+
"Changed": [
122+
"Publish bounded real-strategy comparisons and timing evidence, and authenticate licensed VectorBT Pro installation through GitHub CLI."
123+
],
124+
"Release notes": [
125+
"[Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.5)."
126+
]
127+
}
128+
},
129+
{
130+
"version": "0.1.4",
131+
"date": "2026-09-03",
132+
"sections": {
133+
"Changed": [
134+
"Use the feed VWAP for VWAP execution and reject unavailable required VWAP prices."
135+
],
136+
"Release notes": [
137+
"[Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.4)."
138+
]
139+
}
140+
},
141+
{
142+
"version": "0.1.3",
143+
"date": "2026-08-12",
144+
"sections": {
145+
"Changed": [
146+
"Update pinned GitHub Actions."
147+
],
148+
"Release notes": [
149+
"[Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.3)."
150+
]
151+
}
152+
},
153+
{
154+
"version": "0.1.2",
155+
"date": "2026-08-11 (tag only)",
156+
"sections": {
157+
"Tagged source": [
158+
"The annotated v0.1.2 tag exists. No matching published release or artifact is currently listed in the GitHub/PyPI records checked on 2026-10-15. See [tagged source](https://github.com/ml4t/backtest/tree/v0.1.2)."
159+
]
160+
}
161+
},
162+
{
163+
"version": "0.1.1",
164+
"date": "2026-08-10",
165+
"sections": {
166+
"Changed": [
167+
"Add per-asset position rules for pre-open execution."
168+
],
169+
"Release notes": [
170+
"[Published release notes](https://github.com/ml4t/backtest/releases/tag/v0.1.1)."
171+
]
172+
}
173+
},
174+
{
175+
"version": "0.1.0",
176+
"date": "2026-08-09",
7177
"sections": {
8178
"Added": [
9179
"Versioned compatibility snapshots, beta-artifact migration fixtures, commit-bound release candidates, and exact publication verification.",

‎tests/contracts/test_changelog_generation.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ def test_changelog_generator_uses_an_independent_legacy_source() -> None:
3535
assert generator._LEGACY.read_text(encoding="utf-8").startswith("## 0.1.0b17 -")
3636

3737

38-
def test_beta_18_through_stable_candidate_have_compatibility_impact() -> None:
38+
def test_beta_18_through_first_stable_release_keep_compatibility_history() -> None:
3939
source = json.loads((_ROOT / "release" / "changelog.json").read_text(encoding="utf-8"))
4040
releases = {release["version"]: release for release in source["releases"]}
4141
expected = {"0.1.0", *(f"0.1.0b{number}" for number in range(18, 23))}
4242

43-
assert set(releases) == expected
43+
assert expected <= set(releases)
4444
for version in expected:
4545
assert releases[version]["sections"]["Compatibility"]
4646

0 commit comments

Comments
 (0)