Skip to content

docs: backfill v4.2.0 migration notes#22612

Merged
critesjosh merged 1 commit into
nextfrom
docs/backfill-v4.2.0-migration-notes
Apr 16, 2026
Merged

docs: backfill v4.2.0 migration notes#22612
critesjosh merged 1 commit into
nextfrom
docs/backfill-v4.2.0-migration-notes

Conversation

@critesjosh

Copy link
Copy Markdown
Contributor

Summary

Move four breaking-change migration notes from the unreleased area into the ## 4.2.0 section of the live developer docs, and add them to the v4.2.0 versioned snapshot:

  • GasSettings.default() renamed to GasSettings.fallback() (plus removal of DEFAULT_GAS_LIMIT / DEFAULT_TEARDOWN_GAS_LIMIT)
  • simulateTx / executeUtility / profileTx / proveTx no longer accept scopes: 'ALL_SCOPES'
  • PXE now scope-enforces capsule operations
  • EphemeralArray replaces CapsuleArray in PXE oracle interfaces

These notes were written after the v4.2.0 cut but document breaking changes that shipped in 4.2.0, so they belong in the 4.2.0 section of both the live and versioned docs.

Test plan

  • Migration notes render correctly on the docs site
  • v4.2.0 versioned docs show the backfilled entries under ## 4.2.0
  • Live developer docs no longer list these entries as unreleased

Move four breaking-change entries (GasSettings.default() -> fallback(),
removal of ALL_SCOPES, PXE-level capsule scope enforcement, and
EphemeralArray replacing CapsuleArray in oracle interfaces) from the
unreleased section into the 4.2.0 section of the live developer docs,
and add them to the v4.2.0 versioned snapshot.
@critesjosh critesjosh enabled auto-merge April 16, 2026 18:12
@critesjosh critesjosh added this pull request to the merge queue Apr 16, 2026
Merged via the queue into next with commit dec97a2 Apr 16, 2026
29 of 33 checks passed
@critesjosh critesjosh deleted the docs/backfill-v4.2.0-migration-notes branch April 16, 2026 18:51
@AztecBot

Copy link
Copy Markdown
Collaborator

❌ Failed to cherry-pick to v4-next due to conflicts. (🤖) View backport run.

AztecBot pushed a commit that referenced this pull request Apr 16, 2026
## Summary

Move four breaking-change migration notes from the unreleased area into
the `## 4.2.0` section of the live developer docs, and add them to the
v4.2.0 versioned snapshot:

- `GasSettings.default()` renamed to `GasSettings.fallback()` (plus
removal of `DEFAULT_GAS_LIMIT` / `DEFAULT_TEARDOWN_GAS_LIMIT`)
- `simulateTx` / `executeUtility` / `profileTx` / `proveTx` no longer
accept `scopes: 'ALL_SCOPES'`
- PXE now scope-enforces capsule operations
- `EphemeralArray` replaces `CapsuleArray` in PXE oracle interfaces

These notes were written after the v4.2.0 cut but document breaking
changes that shipped in 4.2.0, so they belong in the 4.2.0 section of
both the live and versioned docs.

## Test plan

- [ ] Migration notes render correctly on the docs site
- [ ] v4.2.0 versioned docs show the backfilled entries under `## 4.2.0`
- [ ] Live developer docs no longer list these entries as unreleased

# Conflicts:
#	docs/developer_versioned_docs/version-v4.1.0-rc.2/docs/resources/migration_notes.md
#	docs/docs-developers/docs/resources/migration_notes.md
AztecBot added a commit that referenced this pull request Apr 17, 2026
Adapt cherry-pick result for v4-next, which does not yet contain the
v4.2.0 versioned snapshot nor the operator v4.2.md source file.

- Revert misdirected rename targets in v4.1.2/operators/changelog/index.md
  and v2.1.11-ignition-sidebars.json (v4.2 entries point to files that do
  not exist on this branch).
- Drop the v4.2 entries from docs-operate/operators/reference/changelog/
  index.md and sidebars-operate.js for the same reason — including them
  would break the Docusaurus build. They should be added back when v4.2
  infrastructure (#22581 / #22612) is backported.

Kept:
- docs-operate/reference/changelog/v4.md content restore (core fix)
- v4.1.2/operators/reference/changelog/v4.md HA-guide link fix (the
  target file is high-availability.md on v4-next too, so the underscore
  link was already broken here).
critesjosh added a commit that referenced this pull request Apr 17, 2026
## Summary

Backport of #22609
onto `v4-next`.

The upstream PR did two things:

1. **Core fix**: restore the full v4.x changelog content (325 lines) in
the docs-operate source. The stub had regressed via PR #22581.
2. **v4.2 discoverability**: advertise `v4.2.md` by adding it to the
operator changelog index, the `sidebars-operate.js` sidebar, and the
`version-v4.2.0/` versioned snapshot.

Only (1) applies to `v4-next`. The v4.2.0 versioned folder and `v4.2.md`
source file do not exist on this branch yet (PRs #22581 / #22612 have
not been backported), so advertising `v4.2.md` would break the
Docusaurus build.

## 3-commit structure

Per `.claude/claudebox/backport.md`:

1. `cherry-pick: ... (with conflicts)` — raw `git cherry-pick -m 1
-Xno-renames cbb09bc` output. Git's rename detection misrouted the
v4.2.0 patches onto `version-v2.1.11-ignition` and `version-v4.1.2`,
producing a conflict plus unwanted auto-merges.
2. `fix: resolve cherry-pick conflicts` — restore
`version-v2.1.11-ignition/reference/changelog/v4.md` to its
pre-cherry-pick state. The conflict was caused by the misdirected
rename, not by real content that belongs here.
3. `fix: adapt backport for v4-next (no v4.2.0 version yet)` — revert
the remaining rename-misfires, and drop the v4.2 entries from
`docs-operate` index.md + `sidebars-operate.js` that would reference the
non-existent `v4.2.md`. Keep the HA-guide link fix
(`high_availability_sequencers` → `high-availability.md`), which is
valid on v4-next too.

## Net effect

```
 docs/docs-operate/reference/changelog/v4.md        | 324 ++++++++++++++++++---
 .../operators/reference/changelog/v4.md            |   2 +-
```

Analysis:
https://gist.github.com/AztecBot/8024d49bed623cf741c9fd64f72505b0

## Test plan

- [ ] `yarn build` in `docs/` succeeds (no broken sidebar / broken-link
errors).
- [ ] `docs/docs-operate/reference/changelog/v4.md` renders with the
full v4.x migration content.
- [ ] Revisit `docs-operate/operators/reference/changelog/index.md` +
`sidebars-operate.js` after #22581 / #22612 are backported to re-add
v4.2 entries.


ClaudeBox log: https://claudebox.work/s/c59bb40b529f1bc2?run=1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants