Release facts: extract per-release truth from source at each tag - #2
Open
GuanzhouSong wants to merge 1 commit into
Open
Release facts: extract per-release truth from source at each tag#2GuanzhouSong wants to merge 1 commit into
GuanzhouSong wants to merge 1 commit into
Conversation
Derive per-release facts (GUCs with defaults, gateway commands, aggregation stages, expression operators, gateway env vars, SQL functions) directly from the documentdb source at each git tag, since CHANGELOG.md tracks internal release trains and does not reliably reflect tag contents. Includes generated deltas for v0.113-0 and v0.114-0; the v0.114-0 delta surfaces six GUC default flips of which the changelog recorded only one.
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
1 participant
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.
What
Adds
scripts/extract_release_facts.pyandscripts/diff_release_facts.py, plus generated fact inventories for v0.112-0 through v0.114-0 (release-facts/*.yml) and release deltas (release-facts/deltas/*.md).Why
CHANGELOG.md tracks internal release trains and is amended after tags are cut, so it cannot drive docs updates. These scripts parse the machine-readable surfaces of the documentdb source at any git ref — GUC registrations, the gateway command dispatch table, aggregation stage/operator tables, gateway env vars,
*--latest.sqlUDFs — and emit one YAML inventory per release. Diffing two inventories yields the true release delta.Proof of value: the v0.114-0 delta surfaces six GUC default flips, of which the changelog recorded one.
Review notes
release-facts/README.md(rationale, usage, known limitations).git archivewithout touching its working tree.Part 1 of 3 — design doc: #1
🤖 Generated with Claude Code
https://claude.ai/code/session_017M2Wqc6hMjT2AZQ3ULi5wa