Skip to content

docs: add CHANGELOG.md and automate GitHub Releases#61

Merged
paradoxbound merged 2 commits into
mainfrom
docs/changelog
Mar 8, 2026
Merged

docs: add CHANGELOG.md and automate GitHub Releases#61
paradoxbound merged 2 commits into
mainfrom
docs/changelog

Conversation

@paradoxbound

Copy link
Copy Markdown
Owner

Summary

  • Adds CHANGELOG.md (Keep a Changelog format) 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 — on each version bump merge, the pipeline extracts the relevant section from CHANGELOG.md and publishes a GitHub Release automatically
  • Satisfies OSPS-BR-04.01: "When an official release is created, that release MUST contain a descriptive log of functional and security modifications"

How it works

The pipeline step extracts release notes using awk to find the ## [X.Y.Z] section in CHANGELOG.md and pipes it to gh 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.md in the same PR that bumps the version in packages/stdio/package.json. The next merge to main will publish the GitHub Release automatically.

Test plan

  • CHANGELOG.md renders correctly on GitHub
  • npm run type-check and npm run build pass
  • After merge + next version bump, verify GitHub Release is created with correct notes

🤖 Generated with Claude Code

Paradoxbound and others added 2 commits March 8, 2026 10:54
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>
@paradoxbound paradoxbound merged commit db773ca into main Mar 8, 2026
12 checks passed
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.

1 participant