[INFRA] Establish unified project-wide standards (issue #14)#4
Merged
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
- 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
- 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 introduces org-wide standards alignment for the VM conversion toolkit repo by linking to centralized AzureLocal standards, adding a standards compliance checklist to the PR template, and enforcing required repo layout via CI.
Changes:
- Add a “Standards” section to
CONTRIBUTING.mdwith links to AzureLocal’s central standards pages. - Extend the PR template with a “Standards Compliance” checklist.
- Add a CI workflow to validate required repository files/directories and (optionally) config/documentation structure.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
CONTRIBUTING.md |
Adds a “Standards” section linking to org-wide standards documentation. |
.github/workflows/validate-repo-structure.yml |
New CI workflow to validate repo structure and required artifacts. |
.github/pull_request_template.md |
Adds a Standards Compliance checklist section to the 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.
Comment on lines
+44
to
+45
| if [ ! -f ".github/PULL_REQUEST_TEMPLATE.md" ]; then | ||
| echo "::error::Missing .github/PULL_REQUEST_TEMPLATE.md" |
|
|
||
| jobs: | ||
| check-structure: | ||
| runs-on: ubuntu-latest |
…/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
Implements unified project-wide standards for the VM conversion toolkit repo, per AzureLocal/azurelocal.github.io#14.
Changes
Links