docs: update validation framework design to match v1 implementation#463
Open
hdamker wants to merge 7 commits intocamaraproject:mainfrom
Open
docs: update validation framework design to match v1 implementation#463hdamker wants to merge 7 commits intocamaraproject:mainfrom
hdamker wants to merge 7 commits intocamaraproject:mainfrom
Conversation
Clarifies the two-field model per DEC-018: message_override replaces the engine message entirely (rare), hint adds fix guidance alongside the preserved engine message (common case).
Standalone API specs are bundled on the snapshot branch and included in the auto-generated source archive. No separate release asset needed.
YAML parses unquoted "off" as boolean False, causing silent bugs in rule metadata processing. Renamed to "muted" which is YAML-safe.
Replace 4-stage model (disabled/advisory/standard/blocking) with 3-stage (disabled/advisory/enabled). Add configurable pr_profile and release_profile fields to central config schema. Update profile selection from hardcoded trigger-based to config-driven with defaults. Blocking enforcement moved entirely to GitHub rulesets. Updated in both Requirements and Detailed Design documents.
Spectral CLI natively follows external $ref during linting, so bundling is not a prerequisite for validation. Moved bundling from a mid-pipeline step to post-validation diagnostic artifact production. Removed source map requirement (not needed), simplified bundling failure handling, and updated engine orchestration to reflect the actual sequential engine pipeline (yamllint, Spectral, Python, gherkin-lint on source files). Updated composite action boundaries (single run-validation shared action), engine summary table format, Check Run annotations, and line number handling sections. Updated in both Requirements and Detailed Design documents.
Replace artifact handoff model with independent bundling: release automation bundles during snapshot creation, validation bundled specs are diagnostic only. Replace release-review PR short-circuit with full-scope validation (all engines). Add release-metadata.yaml fallback for context on snapshot branches. Describe two-gate defense-in-depth model (pre-snapshot + release-review PR). Updated in both Requirements and Detailed Design documents.
Fix stale hardcoded profile references in trigger summary table, cache sync section, and branch/profile annotations. Update last-updated dates to 2026-03-31 in both documents.
hdamker
changed the title
hdamker
requested review from
rartych,
soadeyemo and
tanjadegroot
as code owners
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
2 participants
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.
What type of PR is this?
documentation
What this PR does / why we need it:
Updates the validation framework Requirements and Detailed Design documents to match the v1 implementation. The original documents (merged in #447) were written pre-implementation. During implementation, three architectural decisions changed the design:
1. Configurable profiles and simplified stages
pr_profileandrelease_profilein the central config, rather than hardcoded by trigger type.2. Bundling is output, not prerequisite
$refduring linting — all engines run on source files directly.3. Two-gate defense-in-depth model
release-metadata.yamlon snapshot branches (whererelease-plan.yamlis absent).Also includes prior changes: hint field split into
message_overrideandhint, bundled-spec-in-release clarification.Which issue(s) this PR fixes:
Related to #448 (validation framework umbrella)
Special notes for reviewers:
Commits are organized by topic for easier review:
41105d9/45873c7/b9a0586— hint field split, prior changes3b62ab4— Profile/stage model122767f— Bundling architecture2048b38— Two-gate model and RA integration14627d7— Cross-reference consistency fixesChangelog input
Additional documentation