Vendored OKF specification¶
SPEC.md is a vendored copy of the Open Knowledge Format (OKF)
specification that Outcrop targets (currently v0.2).
- Upstream source: https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md
- Rendered site: https://okf.md/
- Announcement: https://cloud.google.com/blog/products/data-analytics/how-the-open-knowledge-format-can-improve-data-sharing
UPSTREAM records the exact provenance (source URL, content sha256, fetch
date, upstream commit when known) of the vendored copy.
Keeping it current¶
The OKF spec watch workflow (.github/workflows/okf-spec-watch.yml) checks
upstream weekly (and on manual dispatch). When the published spec changes, it
updates this directory and opens a pull request titled
OKF spec sync: upstream changes detected with the diff — review it for
conformance impact (bundle marker shape, reserved filenames, required fields,
provenance/trust families) before merging. Outcrop's conformance points are
tested in outcrop-store (reserved filenames), outcrop-schema (required
type, unknown-key tolerance), and corpus-gen (bundle-root index.md
marker). If the repository setting Allow GitHub Actions to create and approve
pull requests is disabled, the workflow now skips PR creation and leaves a
warning in the job summary instead of failing the run.