Skip to content

docs(release): add mcp-publisher validate pre-tag check + backfill phase issue links#35

Merged
ayhammouda merged 1 commit into
mainfrom
chore/release-runbook-and-phase-issues
May 14, 2026
Merged

docs(release): add mcp-publisher validate pre-tag check + backfill phase issue links#35
ayhammouda merged 1 commit into
mainfrom
chore/release-runbook-and-phase-issues

Conversation

@ayhammouda
Copy link
Copy Markdown
Owner

@ayhammouda ayhammouda commented May 14, 2026

Summary

Two small housekeeping items after the v0.1.5 → v0.1.6 release arc:

1. .github/RELEASE.md — new pre-tag check

The Pre-Release Verification checklist now includes:

```bash
curl -L "https://github.com/modelcontextprotocol/registry/releases/latest/download/mcp-publisher_..." | tar xz mcp-publisher
./mcp-publisher validate server.json
```
Must report `✅ server.json is valid`.

Why: v0.1.5 was a half-publish — PyPI succeeded (no description-length limit; 152-char description accepted) but MCP Registry rejected validation (its schema caps description ≤ 100 chars). The recovery took an extra v0.1.6 patch release. A 10-second local validate before tagging would have caught it.

2. .planning/ROADMAP.md — backfill phase issue links

The post-v0.1.5 backlog table now links the three phase rows to live GitHub issues:

Phase Issue
09 `compare_versions` #32
10 `whatsnew_for_version` #33
11 `detect_python_version` v2 #34

All three issues use the new `phase-plan` label + `help wanted` + `enhancement`, with the corresponding CONTEXT.md content as the issue body.

Out of scope

The RELEASE.md still has stale per-version content (header says "v0.1.1 Release Checklist", grep checks for `0.1.1` in pyproject.toml, etc). Generalizing those to be version-agnostic is a worthwhile cleanup but separate from this fix-and-backfill PR. Suggest a follow-up issue if desired.

Test plan

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated release process documentation with server validation requirements during releases.
    • Updated roadmap with specific tracking references for upcoming features and enhancements.

Review Change Stack

…ase issue links

Two related housekeeping changes after the v0.1.5 → v0.1.6 release arc:

1. .github/RELEASE.md Pre-Release Verification checklist now includes
   running ./mcp-publisher validate server.json against the live MCP
   Registry endpoint before tagging. The v0.1.5 release was a half-
   publish (PyPI succeeded, MCP Registry rejected the 152-char
   description for exceeding the 100-char schema limit) and would have
   been prevented by this 10-second local check.

2. .planning/ROADMAP.md backlog table now links the three phase rows to
   the live GitHub issues opened after PR #27 (#32, #33, #34).

Both changes are documentation-only; no code or workflow changes.
@ayhammouda ayhammouda merged commit 2532244 into main May 14, 2026
6 of 7 checks passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f2ab851d-685c-4617-97de-be6102c9579d

📥 Commits

Reviewing files that changed from the base of the PR and between f948f09 and c26d1fd.

📒 Files selected for processing (2)
  • .github/RELEASE.md
  • .planning/ROADMAP.md

📝 Walkthrough

Walkthrough

This PR updates two planning and documentation artifacts. The release checklist gains a validation step for server.json schema compliance before tagging. The roadmap backlog replaces TBD placeholders with concrete GitHub issue links for three upcoming tool enhancements.

Changes

Documentation and Planning Updates

Layer / File(s) Summary
Release validation checklist step
.github/RELEASE.md
Added checklist instruction to run mcp-publisher validate server.json against the live MCP Registry schema, with expected success output and guidance to shorten description on main if validation fails.
Roadmap issue linking
.planning/ROADMAP.md
Updated Backlog rows for phases 09–11 to replace "#TBD-link-after-PR-merges" with concrete issue references (#32, #33, #34) for upcoming tool features.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🐰 Two checklist steps we compile,
A roadmap now linked, clean and simple,
No code to review, just guides refined,
Release and planning, both aligned!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/release-runbook-and-phase-issues

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

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.

phase 09 — compare_versions(symbol, v1, v2)

1 participant