Skip to content

Commit c3837af

Browse files
authored
docs: add MIGRATION_v5_to_v6 stub for the 6.0-beta line (#823)
Mirrors the precedent set by MIGRATION_v1_to_v2 / v3_to_v4 / v4.0_to_v4.1 — a per-major migration doc that accretes entries as breaking surfaces land on the beta line (starting with #741 canonical-formats). Also serves as the Release-As trigger for the initial 6.0.0-beta.1 bump, since the original trailer on #804 was buried mid-message by the squash-merge and release-please's parser only honors footers at the very end of a commit message. Refs: #802 Release-As: 6.0.0-beta.1
1 parent fc5ee16 commit c3837af

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

MIGRATION_v5_to_v6.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Migration v5 → v6
2+
3+
> Beta line. Surfaces here MAY change between beta increments. Track this
4+
> file as features land; sections will be added per-release rather than
5+
> upfront.
6+
7+
## Why a major version
8+
9+
v6 carries the type-surface changes that come with AdCP 3.1 — most
10+
notably the canonical-formats projection layer (#741), which alters
11+
the `ProductFormatDeclaration` discriminator and adds the
12+
`adcp.canonical_formats` public module. Adopters pinning `adcp~=5.7`
13+
will keep getting the v5 surface; opt into the beta with
14+
`pip install --pre adcp` or `pip install adcp==6.0.0b1`.
15+
16+
## Installing the beta
17+
18+
```bash
19+
pip install --pre adcp
20+
# or pin explicitly
21+
pip install adcp==6.0.0b1
22+
```
23+
24+
PyPI's default resolver excludes prereleases unless `--pre` is set, so
25+
existing `pip install adcp` calls in production continue resolving to
26+
5.7.x.
27+
28+
## What's NOT changing
29+
30+
- `ADCP_VERSION` is the upstream protocol version (currently
31+
`3.1.0-beta.3`) and is independent of the SDK package version. v6 of
32+
the SDK can run against multiple `ADCP_VERSION` values; the schema
33+
cache and generated types are pinned via that file, not via the
34+
package version.
35+
- The CI schema-sync drift gate remains gated on stable upstream
36+
versions (`.github/workflows/ci.yml`).
37+
38+
## Per-release entries
39+
40+
(Add sections here as breaking changes land. Format: heading per
41+
released beta increment, bullet list of breaking surfaces with
42+
migration recipe.)

0 commit comments

Comments
 (0)