Releasing OntoCode / OntoIndex

Maintainer checklist for publishing crates, binaries, and the VS Code extension.

Version bump

1. Update [workspace.package].version in root Cargo.toml on GitHub
2. Update extension/package.json version
3. Update CHANGELOG.md on GitHub and docs/changelog.md
4. Regenerate NOTICES on GitHub if dependencies changed (cargo license recommended)
5. Sync user-facing docs (see checklist below)

Documentation sync checklist (every release)

• [ ] docs/SHIPPED.md — canonical capability matrix (update first)
• [ ] Root README on GitHub — version, link to SHIPPED.md, Read the Docs badge
• [ ] docs/index.md — hero version, capability table, documentation map
• [ ] extension/README.md on GitHub — "What's included", command table
• [ ] docs/vscode-install.md — recommended version, commands
• [ ] docs/getting-started.md — release binary examples (Path D)
• [ ] docs/faq.md — API version, Protégé comparison
• [ ] docs/errors.md / docs/workspace-limits.md — behavior changes
• [ ] docs/guides/enterprise-eval.md — shipped capabilities
• [ ] docs/guides/protege-coexistence.md — v0.8 coexistence (must match SHIPPED)
• [ ] docs/guides/protege-decision.md — decision matrix
• [ ] docs/guides/production-evidence.md — self-benchmark protocol
• [ ] docs/guides/governance.md — sustainability / support policy
• [ ] docs/guides/platform-compatibility.md — VS Code / OS matrix
• [ ] docs/guides/release-timeline.md — non-commitment timeline
• [ ] docs/guides/production-readiness.md — pilot criteria
• [ ] docs/guides/enterprise-deployment.md — air-gap / CI rollout
• [ ] docs/guides/performance-sizing.md — sizing tiers
• [ ] docs/guides/lgpl-compliance.md — legal review pack
• [ ] security.md / SECURITY.md on GitHub — supported versions table
• [ ] docs/changelog.md — mirror recent releases from CHANGELOG.md
• [ ] docs/lsp-api.md — new methods or error codes
• [ ] docs/webview-protocol.md — React panel message protocol
• [ ] docs/guides/graph-visualization.md, obo-workflow.md, robot-interop.md
• [ ] docs/migration/v0.7.md — upgrade notes when applicable
• [ ] docs/design/PROTEGE_PARITY.md — status columns if features shipped
• [ ] docs/design/ARCHITECTURE.md / OWL_AUTHORING_SPEC.md — shipped vs target banners
• [ ] docs/design/LICENSES.md — dependency sections
• [ ] Run mkdocs build --strict locally before tagging
• [ ] Run ./scripts/check-doc-versions.sh (also enforced in CI)

Tag and publish

Push a tag matching [workspace.package].version in Cargo.toml:

git tag v0.8.0   # must match [workspace.package].version in Cargo.toml
git push origin v0.8.0

The release workflow on GitHub:

1. Verifies packages and runs tests
2. Publishes workspace crates to crates.io in dependency order
3. Creates a GitHub Release with:
4. ontoindex Linux x64 binary
5. ontoindex-lsp per-platform archives
6. Multi-platform ontocode-*.vsix

Requires the CARGO_REGISTRY_TOKEN repository secret.

Published crates (dependency order)

ontoindex-core → ontoindex-parser → ontoindex-owl → ontoindex-diagnostics → ontoindex-catalog → ontoindex-refactor → ontoindex-query → ontoindex-reasoner → ontoindex-robot → ontoindex-lsp → ontoindex-cli

VS Code Marketplace

See marketplace-publish.md.

Verify artifacts

release-integrity.md — SHA256SUMS, --locked installs.

Security

Report vulnerabilities per security.md — not via public issues.

Read the Docs

The documentation site is built with MkDocs and hosted at ontocode-vs.readthedocs.io.

1. Read the Docs project slug: ontocode-vs (this sets the *.readthedocs.io subdomain; it cannot be renamed after import — the display name can be “OntoCode” in RTD settings).
2. RTD reads .readthedocs.yaml on GitHub and installs docs/requirements.txt.
3. mkdocs.yml site_url must match the live subdomain (https://ontocode-vs.readthedocs.io/).
4. Pushes to main rebuild the latest version; tags can publish versioned docs.

Local preview: pip install -r docs/requirements.txt && mkdocs serve.