update docs and PR template to close Azure#247

jtracey93 · Jul 29, 2022 · 79382f2 · 79382f2
1 parent 950d241
commit 79382f2
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -21,6 +21,7 @@ Replace this with any testing evidence to show that your Pull Request works/fixe
 ## As part of this Pull Request I have
 
 - [ ] Read the [Contribution Guide](https://github.com/Azure/ALZ-Bicep/wiki/Contributing) and ensured this PR is compliant with the guide
+- [ ] Ensured the resource API versions in `.bicep` file/s I am adding/editing are using the latest API version possible
 - [ ] Checked for duplicate [Pull Requests](https://github.com/Azure/ALZ-Bicep/pulls)
 - [ ] Associated it with relevant [GitHub Issues](https://github.com/Azure/ALZ-Bicep/issues)
 - [ ] *(ALZ Bicep Core Team Only)* Associated it with relevant [ADO Items](https://aka.ms/alz/bicep/backlog)

diff --git a/docs/wiki/Contributing.md b/docs/wiki/Contributing.md
@@ -16,6 +16,7 @@
   - [Bicep File Structure](#bicep-file-structure)
   - [Bicep File Structure Example](#bicep-file-structure-example)
 - [Constructing a Bicep Module](#constructing-a-bicep-module)
+  - [Resource API Versions](#resource-api-versions)
 
 ---
 
@@ -243,3 +244,7 @@ To author Bicep modules that are in-line with the requirements for this project,
     - `<parameterSet>` denotes a set of parameters with similar characteristics, for example: `securityGroup`
     - `parameters` constant to denote the file as a parameters file
     - `<min|all>.json` denotes whether a parameter file contains all possible parameters or only minimum necessary for deployment
+
+### Resource API Versions
+
+Each resource must use the latest available, working, API version. If the latest API version cannot be used for any reason, a comment must be placed above the resource in the module file stating why and also called out as part of the PR.