Repository navigation
Make release-note updates portable and finalize versioned headings - #204
Merged
Merged
Conversation
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
konn
marked this pull request as ready for review
October 2, 2026 06:09
NY57
requested changes
Oct 6, 2026
Co-authored-by: Codex <noreply@openai.com>
konn
force-pushed
the
codex/portable-yaml-roundtrip
branch
from
October 6, 2026 04:34
6d9fa4f to
1fa7a2f
Compare
NY57
requested changes
Oct 6, 2026
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
konn
enabled auto-merge
October 6, 2026 05:13
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Release-note tasks and the CI guard depended on incompatible implementations of
yqacross environments. The guard also inspected a different TOC section from the one the release tasks updated, allowing unreleased references to go undetected.Replace these calls with a Python helper using
ruamel.yaml, pinned in the existingdevextra anduv.lock. The helper selects the release section by caption, preserves comments, quotes, ordering, and LF/CRLF, rejects conflicting or malformed entries, and validates both TOCs before replacing files. Release tasks perform a dry-run check before changing notebooks, and CI checks the entire TOC for unreleased references.Finalization renames both language notebook/Markdown pairs, replaces the first
X.XX.Xin each Markdown release title with the supplied version, and uses Jupytext throughuvto regenerate and execute the notebooks from the renamed Markdown. Later placeholders remain unchanged. Explicit Markdown conversion makes it authoritative even when an existing notebook is newer; execution failures stop before the TOC update.Run all 25 regression tests once in an independent Ubuntu/Python 3.11 job, covering both languages and LF/CRLF cases. Include local Taskfile commands and contributor instructions.
Validation
devdependencies.task check_book_enandtask check_book_japassed, including full notebook execution and warnings-as-errors builds.task check_paired_notebookspassed with a writable temporaryJUPYTER_DATA_DIRfor the sandbox.task check_release_toc,uv lock --check, andgit diff --checkpassed.Successful notebook runs emitted sandbox-related kernel shutdown diagnostics. Remote CI results are reported by the PR checks.