docs: Add formal deprecation policy#122
Open
jonathanMLDev wants to merge 1 commit into
Open
Conversation
📝 WalkthroughWalkthroughThis PR establishes a formal deprecation policy for the package covering semantic versioning, breaking-change timelines, and maintainer obligations. It adds a core policy document, a release notes template, updates contributor and release guidance, and cross-references the new documentation across README files. ChangesDeprecation Policy & Release Process
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #122 +/- ##
=======================================
Coverage ? 81.21%
=======================================
Files ? 38
Lines ? 1299
Branches ? 430
=======================================
Hits ? 1055
Misses ? 242
Partials ? 2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/templates/breaking-change-release-notes.md`:
- Line 36: The markdown link "[CHANGELOG —
vX.Y.Z](https://github.com/cppalliance/pinecone-read-only-mcp-typescript/releases/tag/vX.Y.Z)"
is mislabeled: update the link target to point to the actual CHANGELOG file
(e.g., "CHANGELOG.md" or the repo-relative path to it) so the label "CHANGELOG —
vX.Y.Z" matches the destination, or alternatively relabel the link text to
"Release — vX.Y.Z" if you intend to keep the releases page; edit the single
markdown link accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c658e08a-c5bc-4a5a-9473-3bb6f718b2e7
📒 Files selected for processing (8)
CHANGELOG.mdREADME.mddocs/CONTRIBUTING.mddocs/MIGRATION.mddocs/README.mddocs/RELEASING.mddocs/deprecation-policy.mddocs/templates/breaking-change-release-notes.md
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.
Summary
Adds a written release and deprecation policy so consumers and maintainers have explicit rules before larger breaking work (e.g.
ServerContextin issue_01). This is documentation only — nosrc/, test, or workflow changes.Closes the process gap called out in the eval: while CI is strong and
SERVER_VERSIONalready trackspackage.jsonat runtime (since 0.2.0), there was no documented deprecation window, CHANGELOG conventions for breaking releases, or GitHub Release template for breaking versions.Changes
docs/deprecation-policy.md0.y.z, 2-minor deprecation window, maintainer checklist, migration commitment, breaking-without-deprecation rules, CHANGELOG format,ServerContextforward reference,paper_numbergrandfatheringdocs/templates/breaking-change-release-notes.mdREADME.mddocs/README.mddocs/MIGRATION.mddocs/RELEASING.mddocs/CONTRIBUTING.mdCHANGELOG.md[Unreleased]entry for this documentationAcceptance criteria
docs/deprecation-policy.mdspecifying deprecation window (minimum two minor releases)Policy highlights
0.y.z, minors may break per semver §4; consumers should pin exact versions.0.2.x→ earliest removal0.4.0).### Deprecated, MIGRATION section, optional@deprecated/ one-per-processWARN.Breaking (MCP|types|…)bullets, MIGRATION steps, GitHub Release from template.paper_number: grandfathered — removal no earlier than first major after1.0.0, per existing 0.2.0 commitment.Downstream
ServerContext): migration guide should link todocs/deprecation-policy.mdand list legacy getters under### Deprecatedwith removal targets.Test plan
npm run docs:link-check— all new relative links resolvenpm run ci— typecheck, lint, format, build pass (docs-only; no code diff)docs/deprecation-policy.mdfor clarity and alignment with existing 0.2.0 CHANGELOG styleChecklist
[Unreleased]CHANGELOG updatedRelated Issue
Summary by CodeRabbit