Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
35 lines (25 loc) · 1.33 KB

RELEASE_CHECKLIST.md

File metadata and controls

35 lines (25 loc) · 1.33 KB

Release checklist (v0.2+)

Use this before tagging vX.Y.Z.

Pre-release

  • cargo fmt --all -- --check
  • cargo clippy --all-targets -- -D warnings
  • cargo test --workspace
  • Example suites pass: mcp-probe run --config examples/suites/passing.suite.json
  • CHANGELOG.md updated with version and date
  • Workspace version in root Cargo.toml and pyproject.toml match the tag
  • README.md quickstart commands verified on a clean machine
  • action.yml inputs documented and docs/example-workflow.yml matches

Tag and publish

git tag -a v0.2.0 -m "v0.2.0"
git push origin v0.2.0
  • GitHub Release workflow completes (binaries for linux/macos/windows)
  • Attach release notes from CHANGELOG.md
  • Confirm uses: markndg/mcp-probe@v0.2.0 works with version: v0.2.0 (download path)

Post-release

  • Open a PR to bump [Unreleased] → next dev section in CHANGELOG.md on main
  • Optional: publish Python package to PyPI if/when that pipeline exists
  • Announce: capability-aware conformance, GitHub Action, init / inspect / validate-suite

Breaking change policy

Patch releases: bug fixes only. Minor releases: additive JSON report fields and new CLI flags are OK; changing default stdout format was done in 0.2.0 (use --format json for scripts).