[INFRA] Establish unified project-wide standards (issue #14)#7
Merged
Conversation
…issue #15) - Create config/variables.example.yml with IIC example values - Consolidates cluster, credential, and testing config into single entry point - Uses keyvault:// URI format for all secrets - Follows org-wide snake_case naming convention - Subdirectory configs (clusters/, credentials/, profiles/) remain for detailed configs Resolves AzureLocal/azurelocal.github.io#15
Add config/schema/variables.schema.json for validating variables.example.yml. Replace old ajv-cli workflow with standardized Python-based validation. Part of AzureLocal/azurelocal.github.io#15
…es.md - Rename variable-reference.md to variables.md (standard naming) - Rewrite content to match sectioned YAML format from config/variables.example.yml - Add all sections: azure, keyvault, azure_local, storage, networking, credentials, testing, monitoring, reporting, winrm, tags - Add naming rules table and Key Vault resolution docs - Update mkdocs.yml nav entry Part of: AzureLocal/azurelocal.github.io#15
- Replace docs/standards/ content with links to central standards - Update CONTRIBUTING.md with links to central standards - Add standards compliance checklist to PR template - Add validate-repo-structure CI workflow
kristopherjturner
added
type/infra
7 tasks
There was a problem hiding this comment.
Pull request overview
This PR centralizes repository standards documentation by replacing in-repo standards pages with pointers to org-wide canonical standards, and introduces contributor/process updates (CONTRIBUTING + PR template) plus a new CI workflow intended to validate repo structure.
Changes:
- Replaced multiple
docs/standards/*.mddocuments with short “moved to central standards” stubs and canonical links. - Added a “Standards” section to
CONTRIBUTING.mdand a “Standards Compliance” checklist to the PR template. - Added a GitHub Actions workflow to validate required files/directories and documentation/config structure.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/standards/variables-environment-standards.md | Replaced detailed variable/env standards with central doc links (plus repo-local reference link). |
| docs/standards/scripting-standards.md | Replaced detailed scripting standards with central canonical link. |
| docs/standards/documentation-standards.md | Replaced detailed documentation standards with central canonical link. |
| docs/standards/badge-standards.md | Replaced detailed badge library with central canonical link. |
| CONTRIBUTING.md | Added pointers to org-wide standards and policies. |
| .github/workflows/validate-repo-structure.yml | New workflow to enforce required repo files/dirs and validate config/doc structure. |
| .github/pull_request_template.md | Added standards compliance checklist items to PR template. |
💡 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.
| 4. Update any scripts that should consume the new variable | ||
| 5. Add the variable to the documentation appendix (Appendix A — Variable Reference) | ||
| 6. Increment the metadata `version` and update `last_modified` | ||
| See also: [Variable Reference](../reference/variables.md) for this repo's specific variables. |
| - name: Check required root files | ||
| run: | | ||
| missing=0 | ||
| for f in README.md CONTRIBUTING.md LICENSE CHANGELOG.md .gitignore; do |
Comment on lines
+44
to
+45
| if [ ! -f ".github/PULL_REQUEST_TEMPLATE.md" ]; then | ||
| echo "::error::Missing .github/PULL_REQUEST_TEMPLATE.md" |
Comment on lines
+54
to
+59
| if [ ! -f "config/variables.example.yml" ]; then | ||
| echo "::error::Missing config/variables.example.yml" | ||
| missing=$((missing + 1)) | ||
| fi | ||
| if [ ! -f "config/schema/variables.schema.json" ]; then | ||
| echo "::error::Missing config/schema/variables.schema.json" |
Comment on lines
+73
to
+74
| if [ ! -f "docs/reference/variables.md" ]; then | ||
| echo "::error::Missing docs/reference/variables.md (required when config/ exists)" |
…/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 loadtools repo standards to reference the central standards at azurelocal.cloud/standards, per AzureLocal/azurelocal.github.io#14.
Changes
Links