Add conformance.toml manifest and CI guard#77
Merged
Conversation
Records which openarmature-spec proposals are implemented in this package and at which release version. The openarmature-spec docs build fetches this file from raw.githubusercontent.com to render a per-implementation status column on the proposals index page. scripts/check_conformance_manifest.py validates the file against the pinned spec submodule's proposals/ on every PR and release build, so a stale entry can't quietly serve wrong data to the docs site. Seeded from CHANGELOG: 23 implemented, 3 textual-only (0019, 0026, 0030). Proposal 0031 is intentionally absent: it was accepted on spec main after the v0.9.0 cut and isn't in the pinned submodule.
There was a problem hiding this comment.
Pull request overview
Adds a repo-level conformance manifest and CI validation to keep openarmature-python’s implemented-proposal list in sync with the pinned openarmature-spec submodule, so external consumers (notably the spec docs build) can reliably render implementation status.
Changes:
- Add root
conformance.tomlmapping accepted spec proposals to implementation status and first-shipped version. - Add
scripts/check_conformance_manifest.pyand run it in CI/release workflows to validate manifest ↔ pinned spec proposal set consistency. - Update
RELEASING.mdchecklist to require keeping the manifest current during releases.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/check_conformance_manifest.py | New CI guard to validate the conformance manifest against the spec submodule proposals. |
| conformance.toml | New manifest listing per-proposal implementation status and since versions. |
| RELEASING.md | Adds a release checklist item to keep the manifest and spec_pin current. |
| .github/workflows/ci.yml | Runs the new manifest validation step on PRs. |
| .github/workflows/release.yml | Runs the new manifest validation step on tag-based release builds. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Two structured errors instead of AttributeError / TypeError tracebacks when conformance.toml has a malformed shape: - Entry that's a scalar instead of a table (e.g., accidentally writing `proposals."0001" = "oops"` at the top level). - `since` value that's an int because the version was written without quotes (e.g., `since = 1` instead of `since = "1.0.0"`). Both are plausible hand-edit typos. The guard now emits the script's standard ::error::-style messages for either, matching the rest of the validator's failure output. Addresses CoPilot PR review feedback on #77.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
conformance.tomlat the repo root listing which openarmature-spec proposals are implemented in this package and at which release version. Seeded from CHANGELOG: 23implemented, 3textual-only(0019, 0026, 0030).scripts/check_conformance_manifest.pyvalidates the manifest against the pinned spec submodule'sproposals/directory on every PR and release build. Catches missing entries, stale entries (proposals that no longer exist or aren'tAccepted), unknown status values, and malformedsinceversions.raw.githubusercontent.com/LunarCommand/openarmature-python/main/conformance.tomlto render a per-implementation status column on the proposals index page.RELEASING.mdpre-release checklist gets a new bullet so the manifest is refreshed in lockstep withCHANGELOG.md.Proposal 0031 (Langfuse mapping) is deliberately absent: it was accepted on spec
mainafter the v0.9.0 cut and isn't in the pinned submodule. The manifest's scope is "proposals visible in the pinned spec submodule"; the spec docs site computes the pinned-vs-head gap on its end.Test plan
uv sync, before lint, in bothci.ymlandrelease.yml)python3 scripts/check_conformance_manifest.pyexits 0 locally and printsOK: 26 accepted proposals, 26 manifest entries, all consistentconformance.tomlagainstCHANGELOG.md