Skip to content

Migrate to category-folder changelog fragments - #1919

Open
tconley1428 wants to merge 7 commits into
mainfrom
chore/changelog-fragments
Open

tconley1428 wants to merge 7 commits into
mainfrom
chore/changelog-fragments

Conversation

@tconley1428

@tconley1428 tconley1428 commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Move pending Python SDK release notes into per-PR Markdown files under category folders. Contributors choose fun, whimsical filenames and write only the note body without a leading list marker. Entries should be concise, ideally one or two sentences, each entirely on one line because each nonempty line becomes a separate list item. Fragments may contain multiple entries. Release preparation prepends a dated section, adds one bullet per nonempty line, and removes exactly the consumed files after version and lockfile updates succeed. CHANGELOG.md contains completed releases only.

Use sdk-rust's shared tooling for fragment checks, changelog writing and consumption, dated-section extraction, and Core revision selection. Python updates its versions and lockfile first, then invokes the tool with the new release version and date. Python retains Git/PR orchestration; no hook or JSON release plan is needed. Switch the checkpoint to the alternative organization-wide fragment workflow and update contributor/agent guidance.

Dependencies:

Both dependencies are pinned to published PR commit SHAs so this draft can exercise the shared workflow before they merge. Re-pin if upstream commits change or are squash-merged.

Validation: 14 targeted release-script tests passed, along with import/format checks, targeted type checks, and actionlint. Rust tooling has 22 passing tests and targeted Clippy checks. A disposable checkout ran real uv lock, consumed all seven migrated fragments, committed the prepared release, and verified the version and published notes through the actual release verifier. Duplicate and empty releases were rejected, and a late fragment was consumed by a subsequent release while preserving history. No release was pushed or published. No SDK release-version bump is required.

Changelog validation failures leave the earlier local version/lockfile updates for inspection while preserving the changelog and fragments. Preparation stops before committing; filesystem failures during writes or deletion may require local recovery.

Comment thread changelog/README.md
Comment thread changelog/README.md Outdated
Comment thread AGENTS.md
@tconley1428
tconley1428 marked this pull request as ready for review October 5, 2026 16:59
@tconley1428
tconley1428 requested a review from a team as a code owner October 5, 2026 16:59

@THardy98 THardy98 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm but i don't really have strong opinions on this

Comment thread CONTRIBUTING.md
Comment thread AGENTS.md
Comment on lines +78 to +79
for each applicable category. Use fun, whimsical, unique lowercase kebab-case
filenames, such as `giggling-teapot.md`. The folder supplies the category;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not to dampen the fun, but this becomes annoying for anyone creating a change w/o an agent. Offering a command that creates this file for you would be nice (this is the approach change sets took in pre-AI world)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants