docs: add CHANGELOG.md and automate GitHub Releases#61
Merged
Conversation
Adds a Keep a Changelog-formatted CHANGELOG.md documenting all releases from v2.1.0 through v2.5.5. Adds a 'Create GitHub Release' step to the merge job in docker-publish.yml that extracts the relevant section from CHANGELOG.md and publishes a GitHub Release on each version bump, satisfying OSPS-BR-04.01 (releases must contain a descriptive log of modifications). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Summary
CHANGELOG.md(Keep a Changelog format) documenting all releases from v2.1.0 through v2.5.5mergejob indocker-publish.yml— on each version bump merge, the pipeline extracts the relevant section fromCHANGELOG.mdand publishes a GitHub Release automaticallyHow it works
The pipeline step extracts release notes using
awkto find the## [X.Y.Z]section inCHANGELOG.mdand pipes it togh release create --notes-file -. The step is idempotent — if the release already exists (e.g. on a workflow re-run) it skips without error.Workflow: going forward, update
CHANGELOG.mdin the same PR that bumps the version inpackages/stdio/package.json. The next merge to main will publish the GitHub Release automatically.Test plan
CHANGELOG.mdrenders correctly on GitHubnpm run type-checkandnpm run buildpass🤖 Generated with Claude Code