Skip to main content

Versioning and Changelog

This page explains how OGAL/OPP changes are versioned, how docs map to protocol versions, and the latest logged updates.

Versioning Policy​

OGAL Protocol​

  • Default posture: avoid breaking changes; prefer additive or optional behavior.
  • Non-breaking changes: additive instruction updates, new optional fields, or tooling-only improvements.
  • Breaking changes: require a governance decision, a published migration path, and explicit communication in this changelog.
  • Compatibility: older assets and proofs remain valid; upgrades should not invalidate ownership guarantees.

OPP Schema​

OPP follows semantic versioning:

  • Major (X.0.0): breaking schema changes or removals.
  • Minor (0.X.0): backward-compatible additions (new optional fields, new enums with defaults).
  • Patch (0.0.X): clarifications, typo fixes, and no-logic documentation fixes.

Tooling (SDKs, Toolbelt, Validators)​

  • Semantic versioning aligned to the OPP schema and OGAL protocol compatibility.
  • Compatibility notes are recorded per release when a tool requires a newer schema or protocol feature.

How Docs Map to Protocol Versions​

  • The docs site reflects latest stable OGAL and OPP versions.
  • When a breaking change is introduced, the docs add:
    • A clear compatibility note on affected pages.
    • A new changelog entry with migration guidance.
    • Version-specific notes or archived pages if behavior diverges.
  • Documentation-only updates (clarifications, examples, formatting) do not imply protocol changes.

Changelog (Recent Updates)​

This log starts on 2025-12-26. Earlier changes may not be captured here.

2025-12-26​

  • OGAL: Baseline entry (no protocol changes recorded in this log yet).
  • OPP: Baseline entry (no schema changes recorded in this log yet).
  • Tooling: Baseline entry (no tooling changes recorded in this log yet).
  • Docs: Added versioning policy and initialized the changelog page.