Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (42 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 4.12 KB
Raw

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Changing managed files

Every file under terraform/files/ is copied verbatim into the AVM module repositories that are mapped to that file group, so a change here lands in many repositories at once.

  • Add a file to terraform/files/root/ to ship it to every module repository.
  • Add a file to a non-root group to ship it only to repositories mapped to that group.
  • To stop shipping a file, remove it and add its path to that group's deletedFiles in terraform/config/managed-files.json so it is also deleted from repositories that already have it.
  • To keep a root file out of one group, add its path to that group's deletedFiles. A deletedFiles entry overrides any file contributed by a lower-order group.

Repository-to-group mapping lives in azure-verified-modules-tools.

Changing issue triage release detection

Edit terraform/root/.github/workflows/issue-triage.md, then regenerate its lock with the gh aw version recorded in the lock header:

gh aw compile --dir terraform/root/.github/workflows
./scripts/Test-IssueTriageReleaseStatus.ps1
./scripts/Test-IssueTriageReleaseStatus.ps1 -WorkflowPath ./terraform/root/.github/workflows/issue-triage.lock.yml
./scripts/Test-GhAwActionPin.ps1

Never bump github/gh-aw-actions/* pins by hand or through Dependabot. They're version-locked to the compiler, and a newer setup action can drop scripts that the lock still calls. Test-GhAwActionPin.ps1 fails when a pin doesn't match the lock's compiled gh aw version.

The regression script requires PowerShell 7.4+, Bash, jq, and timeout. Ubuntu runners provide these tools; Windows can use Git Bash with jq on its PATH. Fixtures replace gh and execute the actual workflow shell without network access. They cover ancestry summaries beyond 250 commits, missing or misleading message references, merge results, release branches, pagination, API failures, evidence vetoes, and lookup budgets. The repository validation workflow runs both the canonical and compiled steps.

Ubuntu CI checks compatibility with the runner's Bash and jq versions. Local runs with newer tools do not replace that check.

Release proof uses each merged PR's post-merge commit, not a commit-message PR-number list. A positive result names a containing published stable release, not necessarily the first one. Divergent histories stay unknown unless another release proves inclusion; cherry-picked content is not automatically equivalent to the PR's merge result. The model must still establish that the PR fixes the issue and honor the human-reopen and incomplete-screening vetoes. These fixtures exercise computed evidence, not the model's final safe-output choices.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.