docs(config): document pipeline.config.json schema + wire CI validation#93
Merged
Merged
Conversation
Expand docs/onboarding/pipeline-configuration.md to cover the JSON Schema added in 9c93b99: - New 'Schema & Validation' section linking to the schema file, explaining the $schema autocomplete behavior, local validation commands, exit codes, and CI enforcement - 'Editor Setup' subsection with the VS Code json.schemas mapping - 'Shared Types' section documenting all 9 $defs - Every schema field (224 property/type names) documented with type, default (from the live config), and a JSON example - Added previously-undocumented sections: reporting, security subsections (snyk/csp/inputSanitization/headers), top-level mutationTesting, deadCode, caching, profiling, incrementalBuild, dashboard Wire schema validation into CI: the script-tests job now runs 'node scripts/validate-pipeline-config.js' on every push/PR, so any change to pipeline.config.json is validated against the schema before merge. Closes #84. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
1 participant
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
Documents the JSON Schema for
pipeline.config.json(added in 9c93b99) and wires schema validation into CI. Resolves all four acceptance criteria from #84.Acceptance criteria
docs/onboarding/pipeline-configuration.mdlinking to the schema file## Schema & Validationlinks to.claude/pipeline.config.schema.jsonField / Type / Default / Descriptiontables + a JSON example per sectionjson.schemasmapping)### Editor Setupwith.vscode/settings.jsonsnippet +$schemaauto-pickup notepipeline.config.jsonscript-testsjob runsnode scripts/validate-pipeline-config.json every push/PRDoc changes
$schemadrives editor autocomplete, local validation (./scripts/validate-pipeline-config.sh,--json/--config/--schema), exit codes (0/1/2), and CI enforcement.$defs.reporting, thesecuritysubsections (snyk/csp/inputSanitization/headers), top-levelmutationTesting,deadCode,caching,profiling,incrementalBuild,dashboard.Verification
node scripts/validate-pipeline-config.jspasses against the live config (so the new CI step is green).pnpm prettier --checkpasses; pre-commit doc-count guard passes.Milestone: v1.1.0 (only
v1.0.0is tagged, so v1.1.0 has not been cut yet).Closes #84.
🤖 Generated with Claude Code