ci: automate CHANGELOG extraction for GitHub Release and release PR workflow#60
Merged
ci: automate CHANGELOG extraction for GitHub Release and release PR workflow#60
Conversation
…e commit On release branch creation, rewrite the [Unreleased] section header to the versioned tag (e.g. [v1.2.3]) via sed, and stage CHANGELOG.md alongside package.json so the header change ships in the release PR. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Add an "Extract changelog section" step that uses awk to pull the versioned section from CHANGELOG.md and trim surrounding blank lines. Pass the result to "Create GitHub Release" via an env var so the migration guide appears in the Release body alongside the auto-generated notes. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
key existed in v0.1.x as `key?: unknown`. The actual change was narrowing it to required `string`, not adding it from scratch. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Add the missing key?: unknown field to the v0.1.x interface snapshot, and correct the comment from "added" to "narrowed" to match reality. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace the outdated interface with the actual discriminated union type. Update the accompanying bullet point to reflect that issues is [] on success and non-empty on failure. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace `issues: ParseIssue[]` with `issues: [ParseIssue, ...ParseIssue[]]` in api-contract.md (type narrowing comment) and good-code.md (type definition and narrowing comment), matching the actual v0.2.0 type. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
AGENTS.md: correct ParseResult failure issues type from ParseIssue[] to [ParseIssue, ...ParseIssue[]], matching the actual v0.2.0 type. docs/PUBLISHING.md: add missing "Update CHANGELOG" step to the Prepare Release PR workflow overview. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #60 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 23 23
Branches 5 5
=========================================
Hits 23 23 🚀 New features to boost your workflow:
|
roottool
added
ci
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.
Description
This PR improves the release workflow in two ways:
prepare-release-pr.yml: The[Unreleased]CHANGELOG header is now rewritten to the versioned tag (e.g.[v1.2.3]) andCHANGELOG.mdis staged alongsidepackage.jsonin the release commit, so the header change ships as part of the release PR.publish.yml: A new "Extract changelog section" step usesawkto pull the versioned section fromCHANGELOG.mdand passes it to the GitHub Release body via an env var, so migration guides appear in the Release body alongside the auto-generated notes.Also includes a batch of documentation corrections across README, CHANGELOG, AGENTS.md, PUBLISHING.md, and skill references to align type definitions with the actual v0.2.0 shapes.
Type of Change
Boundary Checklist (Required for Implementation Changes)
Security & API Stability
Security Impact
API Contract
parsefunction signature, type definitions)ParseResult,ParseIssue, orIssueCodeVersioning
Testing
Automated Checks
bun run check:type:source)bun run test)bun run build)🤖 Generated with Claude Code
Co-Authored-By: Claude Sonnet 4.6 noreply@anthropic.com