Skip to content

Versioning and stability policy - #56

Merged
ronaldtse merged 1 commit into
mainfrom
docs/versioning-policy
Aug 23, 2026
Merged

Versioning and stability policy#56
ronaldtse merged 1 commit into
mainfrom
docs/versioning-policy

Conversation

@ronaldtse

Copy link
Copy Markdown
Contributor

Summary

docs/VERSIONING.md — answers the "this repo churns" committee attack with a policy:

  • MAJOR.MINOR.PATCH over the repository as one artifact (modules + grammars + diagrams move together); PATCH editorial, MINOR additive (profiles remain valid across additive releases — guaranteed by narrowing-only), MAJOR requires a deprecation cycle
  • Deprecation cycle: a construct removed in N+1 is first deprecated in a MINOR of N, and stays instance-covered by the test suite until removal
  • Standardization snapshots: standard/<milestone> immutable tags referenced by the standard; errata are PATCH releases, substantive change is balloted first, lands here after adoption
  • CI gate declared as the breaking-change audit

Note: the standard/<milestone> tags are yours to create — per policy I don't tag.

Test plan

  • rake check green; README links the policy
  • CI green

MAJOR.MINOR.PATCH over the model repository as one artifact; PATCH
editorial, MINOR additive (profiles remain valid), MAJOR with a
deprecation cycle that keeps deprecated constructs instance-covered
until removal. Standardization snapshots are tagged
standard/<milestone> and referenced by the document; errata are PATCH
releases, substantive change is balloted first. The CI gate is the
breaking-change audit.
@ronaldtse ronaldtse closed this Aug 23, 2026
@ronaldtse
ronaldtse deleted the docs/versioning-policy branch August 23, 2026 12:24
@ronaldtse
ronaldtse restored the docs/versioning-policy branch August 23, 2026 12:24
@ronaldtse ronaldtse reopened this Aug 23, 2026
@ronaldtse
ronaldtse merged commit c145c1d into main Aug 23, 2026
9 checks passed
@ronaldtse
ronaldtse deleted the docs/versioning-policy branch August 23, 2026 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant