Skip to content

Releasing

Use this checklist before publishing a new CDP Index release or pushing docs changes to the public site.

Positioning

  • Confirm the README and docs still describe the current CDP scope.
  • Check that docs, templates, MCP behavior, and workflows describe the same operating model.
  • Make sure example repo entries point at real paths or are clearly marked as references.

Quality Checks

bash
make check
npm run docs:build
npm run check:watson
npm run test:watson

MCP Readiness

  • Verify mcp/README.md matches the actual resources and tools.
  • Check mcp/pyproject.toml dependencies for a clean install.
  • Start the server locally with make mcp-run or cd mcp && uv run src/server.py.
  • Smoke-test 221b://docs, 221b://repos, and the search tools.

Docs Deployment

  • Build the VitePress site.
  • Confirm llms.txt and llms-full.txt exist in docs/.vitepress/dist.
  • Deploy with npm run docs:deploy.
  • Verify the configured custom hostname, /llms.txt, and /llms-full.txt.

Release Notes

  • Add an Unreleased note or version entry in CHANGELOG.md.
  • Summarize new docs, templates, registry changes, workflow changes, or MCP capabilities.
  • Call out breaking changes if resource names, file locations, or registry fields changed.

CDP operating memory.