docs(release): generalize RELEASE.md to be version-agnostic + drop one-time scaffolding#36
Conversation
…e-time scaffolding Cleans up RELEASE.md after the v0.1.5/v0.1.6 release wave. Three structural fixes that together cut the file from 205 to 114 lines: 1. Collapse the duplicate "Creating a Release" + "v0.1.1 Release Checklist" sections into one canonical "Release Checklist" using an X.Y.Z placeholder. Maintainers replace X.Y.Z with the version they are releasing. 2. Replace hardcoded versions (0.1.1, 0.1.2) and `<owner>` template URLs with X.Y.Z placeholders and the actual repo URL. The two surviving numeric references (0.1.7 as the example version; v0.1.5 → v0.1.6 as historical context for the mcp-publisher-validate step) are intentional. 3. Drop the "Post-PyPI Launch Pack Cleanup" section entirely. That work (PRE-PYPI fence strip, docs/launch/ submission paths, manual MCP Registry submission) was a one-time scaffolding for the PyPI debut. PRE-PYPI fences are gone from README; MCP Registry publish is now automated by the release workflow; docs/launch/ is not tracked. Preserves from earlier work: - The mcp-publisher validate check added in PR #35. - The Trusted Publishing one-time setup steps. - Coverage notes (Python 3.13 release matrix; docs 3.10–3.14). Adds: - Lockstep version check across all four files (pyproject.toml + server.json:11 + server.json:17 + uv.lock). - Cache-bust step in fresh-install verification (lesson from v0.1.6 where uvx returned stale 0.1.5 until --refresh-package). - MCP Registry isLatest check via JSON API.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe release documentation in ChangesRelease Documentation Update
Estimated Code Review Effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly Related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Summary
Post-launch cleanup of
.github/RELEASE.md. After running the v0.1.5 → v0.1.6 release arc through the existing runbook, three structural issues surfaced:Two parallel "release process" sections (lines 32–58 "Creating a Release" + lines 73–204 "v0.1.1 Release Checklist") describing essentially the same workflow with different levels of detail. Merged into one canonical checklist.
Stale version-specific strings throughout:
0.1.1in 7 places,0.1.2in 2 places,<owner>template URLs in 4 places. Replaced with anX.Y.Zplaceholder convention and the actual repo URL.Entire "Post-PyPI Launch Pack Cleanup" section (lines 164–188) was scaffolding for the PyPI debut: PRE-PYPI fence removal, manual
mcp-publishersubmission,docs/launch/post coordination. All of that is now either done (PRE-PYPI gone), automated (MCP Registry publish), or out of scope (docs/launch/is local-only).Result
pyproject.toml)uvx python-docs-mcp-server --versionreturned stale0.1.5until--refresh-package)isLatestcheck via JSON API (so the verification doesn't depend on a human eyeballing the registry page)Preserved
mcp-publisher validatepre-tag check from PR docs(release): add mcp-publisher validate pre-tag check + backfill phase issue links #35Test plan
0.1.xversions except the example (0.1.7) and the historical reference (v0.1.5 → v0.1.6)<owner>template stringsmcp-publishervalidate step still presentX.Y.Z🤖 Generated with Claude Code
Summary by CodeRabbit