[INFRA] Standardize variable management (issue #15)#3
Closed
kristopherjturner wants to merge 3 commits into
Closed
[INFRA] Standardize variable management (issue #15)#3kristopherjturner wants to merge 3 commits into
kristopherjturner wants to merge 3 commits into
Conversation
…#15) - Create config/ directory with variables.example.yml - Documents common parameters needed across all conversion scripts - Uses org standard snake_case naming and IIC placeholder values - Add config/variables.yml to .gitignore Resolves 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
There was a problem hiding this comment.
Pull request overview
Introduces a standardized, repo-local configuration pattern for VM conversion scripts by adding an example variables file, a JSON Schema to validate its structure, and a CI workflow to enforce that validation.
Changes:
- Added
config/variables.example.ymlas a centralized reference for commonly reused variables. - Added
config/schema/variables.schema.jsonto define/validate the expected config structure. - Added a GitHub Actions workflow to validate the example config and updated
.gitignoreto exclude user-specificconfig/variables.yml.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| config/variables.example.yml | Adds a documented example variables file for users to copy/fill. |
| config/schema/variables.schema.json | Adds a JSON Schema to validate the config structure and required keys. |
| .gitignore | Prevents committing user-specific config/variables.yml. |
| .github/workflows/validate-config.yml | Adds CI validation of the example YAML against the JSON 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.
| pull_request: | ||
| branches: [main] | ||
| paths: | ||
| - 'config/**' |
Comment on lines
+42
to
+46
| run: | | ||
| python3 -c " | ||
| import yaml, json, sys | ||
| from jsonschema import validate, ValidationError | ||
|
|
- Create docs/reference/ directory and variables.md - Full sectioned reference matching config/variables.example.yml - Sections: azure, azure_local, conversion, tags - Add naming rules table and script parameter mapping - Add Reference nav section in mkdocs.yml Part of: AzureLocal/azurelocal.github.io#15
Contributor
Author
|
Superseded by #4 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
Adds config directory, variables.example.yml, and schema validation as part of the org-wide variable management standardization initiative.
Changes
Related