[INFRA] Standardize variable management (issue #15)#57
Closed
kristopherjturner wants to merge 2 commits into
Closed
[INFRA] Standardize variable management (issue #15)#57kristopherjturner wants to merge 2 commits into
kristopherjturner wants to merge 2 commits into
Conversation
Merge naming rules and compatibility section from standards/variables.md into reference/variables.md. Replace standards page with redirect. deployment/variables.md was already a redirect - unchanged. Part of AzureLocal/azurelocal.github.io#15
Add config/schema/variables.schema.json for validating variables.example.yml. Add CI workflow that validates example config against schema on PR. Part of AzureLocal/azurelocal.github.io#15
kristopherjturner
added
type/infra
8 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
This PR consolidates variable standards documentation into the main variable reference and introduces automated validation of the example configuration file via JSON Schema in CI.
Changes:
- Replaced
docs/standards/variables.mdcontent with a “page moved” notice pointing to the consolidated variable reference. - Added “Naming Rules” and “Compatibility” sections to
docs/reference/variables.md. - Introduced a JSON Schema for
config/variables.example.ymland a GitHub Actions workflow to validate the example config against it.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/standards/variables.md | Converts the old standards page into a redirect-style notice pointing to the consolidated reference. |
| docs/reference/variables.md | Adds naming rules + compatibility notes to the main variable reference. |
| config/schema/variables.schema.json | Adds a JSON Schema intended to validate the structure of config/variables.example.yml. |
| .github/workflows/validate-config.yml | Adds CI job to validate config/variables.example.yml against the schema. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+41
to
+46
| - name: Validate variables.example.yml against schema | ||
| run: | | ||
| python3 -c " | ||
| import yaml, json, sys | ||
| from jsonschema import validate, ValidationError | ||
|
|
Comment on lines
+4
to
+20
| # Triggered on PRs and pushes that touch config/ or this workflow. | ||
| # Validates YAML syntax and JSON Schema compliance. | ||
| # ============================================================================= | ||
|
|
||
| name: Validate Configuration | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| paths: | ||
| - 'config/**' | ||
| - '.github/workflows/validate-config.yml' | ||
| pull_request: | ||
| branches: [main] | ||
| paths: | ||
| - 'config/**' | ||
| workflow_dispatch: |
Comment on lines
+8
to
+17
| "properties": { | ||
| "azure": { | ||
| "type": "object", | ||
| "required": ["subscription_id", "resource_group", "location"], | ||
| "properties": { | ||
| "subscription_id": { "type": "string" }, | ||
| "resource_group": { "type": "string" }, | ||
| "location": { "type": "string" } | ||
| } | ||
| }, |
Contributor
Author
|
Superseded by #58 which now includes all issue-15 variable standardization changes merged with issue-14 unified standards. |
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
Consolidates variable documentation and adds schema validation as part of the org-wide variable management standardization initiative.
Changes
Related