From 55e6e6f723eb4626f3c145dae5ad2ed9243b3204 Mon Sep 17 00:00:00 2001 From: Jack Tracey <41163455+jtracey93@users.noreply.github.com> Date: Fri, 29 Jul 2022 14:55:32 +0100 Subject: [PATCH] update docs and PR template to close #247 (#296) --- .github/PULL_REQUEST_TEMPLATE.md | 1 + docs/wiki/Contributing.md | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b123b8e0f..f25cc8471 100644 --- 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 index ef6e5caf0..00daba785 100644 --- 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,   - `` denotes a set of parameters with similar characteristics, for example: `securityGroup`   - `parameters` constant to denote the file as a parameters file   - `.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.