Skip to content

Machine-readable metadata

abicheck publishes metadata and JSON Schemas for package indexes, citation managers, automated validation, and downstream tools.

Citation and software metadata

These files deliberately contain no unverified ORCID, DOI, or release date. When an archival release DOI is minted, add it to the citation and CodeMeta records in that release.

JSON Schema publication

The package source is authoritative. Identical copies are published with the documentation at stable, versioned URLs:

Every file declares its own canonical HTTPS $id at the linked URL. Versioned paths are immutable contracts: a breaking schema revision receives a new major path (for example, v2) and existing paths remain available. A convenience "latest" URL, if introduced, must not replace a versioned $id.

python scripts/publish_schemas.py refreshes the documentation copies; python scripts/publish_schemas.py --check fails when they are stale. CI also validates the schemas and their metadata. The Pages deployment verifies that all canonical $id URLs are retrievable after publication.