Skip to content

ci: integrate release-please for automated releases#33

Merged
jeff-atriumn merged 2 commits intomainfrom
feat/oss-polish
Feb 26, 2026
Merged

ci: integrate release-please for automated releases#33
jeff-atriumn merged 2 commits intomainfrom
feat/oss-polish

Conversation

@jeff-atriumn
Copy link
Member

@jeff-atriumn jeff-atriumn commented Feb 26, 2026

Change Summary

Integrates Google's release-please to automate versioning, changelog generation, and GitHub Releases. This replaces the manual process of bumping package.json and pushing v* tags.

What changed:

  • Added release-please.yml workflow — runs on push to main, creates/updates a release PR
  • Added release-please-config.json — node release type, clean vX.Y.Z tags, conservative pre-1.0 bumping
  • Added .release-please-manifest.json — tracks current version (0.1.1)
  • Removed Create GitHub Release step from release.yml (release-please handles this now)
  • Downgraded contents: writecontents: read on the publish job
  • Cleaned up CHANGELOG.md to match release-please's format (removed [Unreleased] section and footer reference links)

New release flow:

  1. Merge PR with conventional commits to main
  2. release-please creates/updates a release PR with changelog + version bump
  3. Merge release PR → release-please creates tag + GitHub Release
  4. Tag triggers existing release.yml → typecheck, test, npm publish

Risk & Impact Assessment

Risk Level: low

  • release-please is widely adopted and runs only on main push
  • Existing release.yml npm publish pipeline is unchanged (still triggers on v* tags)
  • No runtime code changes — CI/CD only

Test Plan

  • Verified release.yml still has correct structure after removing the GitHub Release step
  • Config files validated against release-please schema

Manual Verification Steps

  1. Merge this PR to main
  2. Confirm release-please action runs and creates a release PR
  3. Review generated changelog entries in the release PR
  4. On next release, verify release.yml still triggers correctly on tag push

🤖 Generated with Claude Code

- Add Contributor Covenant CODE_OF_CONDUCT.md
- Add CHANGELOG.md (Keep a Changelog format)
- Add homepage and bugs fields to package.json, include LICENSE in npm package
- Add GitHub issue templates (bug report, feature request) and PR template
- Expand Getting Started with Claude Desktop, VS Code, Windsurf instructions
- Add FAQ docs page covering data freshness, accuracy, troubleshooting

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Feb 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
tokencost Ready Ready Preview, Comment Feb 26, 2026 3:18am

Request Review

Adds release-please GitHub Action to automate versioning, changelog
generation, and GitHub Releases on push to main. Removes the manual
GitHub Release step from release.yml to avoid conflicts.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@jeff-atriumn jeff-atriumn changed the title Polish repo for open-source readiness ci: integrate release-please for automated releases Feb 26, 2026
@jeff-atriumn jeff-atriumn merged commit d9f6755 into main Feb 26, 2026
5 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