Skip to content

chore(release): v0.2.0 — changelog, migration, npm alignment#116

Merged
wpak-ai merged 2 commits into
cppalliance:mainfrom
jonathanMLDev:release
May 29, 2026
Merged

chore(release): v0.2.0 — changelog, migration, npm alignment#116
wpak-ai merged 2 commits into
cppalliance:mainfrom
jonathanMLDev:release

Conversation

@jonathanMLDev
Copy link
Copy Markdown
Collaborator

@jonathanMLDev jonathanMLDev commented May 28, 2026

Pull Request

Summary

Prepares v0.2.0 so published npm latest matches breaking changes already on main (PR #109, #115). This PR is docs + version only — no src/ changes.

  • Bump package.json / package-lock.json to 0.2.0
  • Cut CHANGELOG.md: [Unreleased] → [0.2.0] - 2026-05-29; empty [Unreleased] for future work; compare links v0.1.6...v0.2.0 and v0.2.0...HEAD
  • Finalize docs/MIGRATION.md for shipped 0.2.0 (remove “upcoming”; point to CHANGELOG [0.2.0]; add §5 Node.js >= 20.12.0)
  • Update README.md: current version callout, @0.2.0 install/npx/MCP pins, Upgrading from 0.1.x → MIGRATION + CHANGELOG

Acceptance Criteria

  • New release tag published (following semver — major version bump for breaking changes, or pre-release tag like 2.0.0-beta.1)
  • package.json version updated to match the release tag
  • CHANGELOG.md created (or updated) documenting all breaking changes since the last release
  • Migration guide created for the 4 queued breaking changes (canonical issue)
  • npm publish completed (or npm publish CI step configured)
  • README updated with the current version and installation instructions matching the published tag
  • Tests pass in CI (if applicable)
  • PR approved by at least 1 reviewer

Related Issue

Close #106

Summary by CodeRabbit

  • Documentation

    • Released version 0.2.0 with complete release notes and comprehensive migration guide including upgrade steps for breaking changes
    • Introduced Node.js >= 20.12.0 as a required dependency for 0.2.0
    • Updated installation instructions, package pinning guidance, and usage examples throughout documentation
  • Chores

    • Package version bumped to 0.2.0

Review Change Stack

@jonathanMLDev jonathanMLDev self-assigned this May 28, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 28, 2026

📝 Walkthrough

Walkthrough

This PR releases version 0.2.0 as a breaking minor update by bumping the package version, documenting breaking changes in the migration guide, updating the CHANGELOG, and ensuring all installation and usage examples in the README reference the pinned @0.2.0 package version with Node.js >= 20.12.0 requirement.

Changes

Release Version 0.2.0

Layer / File(s) Summary
Package version and changelog for 0.2.0
package.json, CHANGELOG.md
Package version bumped to 0.2.0; CHANGELOG updated with new 0.2.0 release header (dated 2026-05-29) and reference links adjusted so [Unreleased] compares v0.2.0...HEAD and new [0.2.0] compare link references v0.1.6...v0.2.0.
Migration guide for 0.2.0 breaking changes and Node.js requirement
docs/MIGRATION.md
Migration guide intro updated to reference CHANGELOG.md 0.2.0 section as authoritative and mark 0.1.x → 0.2.0 as breaking minor. New subsection documents Node.js >= 20.12.0 as minimum supported runtime with local and CI upgrade steps. Summary checklist extended with Node.js version verification item.
README installation and usage documentation pinned to @0.2.0
README.md
"Current version: 0.2.0" note added with breaking change warning and migration/changelog references. All installation snippets (npm, yarn, pnpm, global) and usage examples (Claude Desktop config, npx CLI invocations, deploy examples) consistently pinned to @will-cppa/pinecone-read-only-mcp@0.2.0. Production-oriented defaults bullet updated to reference MIGRATION.md upgrading guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • AuraMindNest
  • wpak-ai

Poem

🐰 A release hops forth with version two,
Breaking changes noted, migration guide true,
Node twenty awaits, docs point the way,
Installation pinned for a stable day!
The changelog sings of what's old and new. 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main changes: a v0.2.0 release preparation including changelog, migration documentation, and npm package alignment.
Linked Issues check ✅ Passed The PR addresses all coding-related requirements from #106: package.json version bumped to 0.2.0, CHANGELOG.md updated with release section, migration guide finalized in docs/MIGRATION.md, and README installation instructions updated to reference v0.2.0.
Out of Scope Changes check ✅ Passed All changes are directly aligned with release preparation: version metadata, documentation updates, and changelog—no unrelated code modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@297eb32). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #116   +/-   ##
=======================================
  Coverage        ?   81.21%           
=======================================
  Files           ?       38           
  Lines           ?     1299           
  Branches        ?      430           
=======================================
  Hits            ?     1055           
  Misses          ?      242           
  Partials        ?        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jonathanMLDev jonathanMLDev requested a review from wpak-ai May 28, 2026 23:58
@wpak-ai wpak-ai merged commit 6a07fd8 into cppalliance:main May 29, 2026
12 checks passed
@wpak-ai
Copy link
Copy Markdown
Collaborator

wpak-ai commented May 29, 2026

@jonathanMLDev jonathanMLDev deleted the release branch June 1, 2026 17:43
@coderabbitai coderabbitai Bot mentioned this pull request Jun 1, 2026
13 tasks
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.

Publish Release Tag Aligning HEAD Breaking Changes With npm

2 participants