From 99d592fdbc9ecfeb4b86ddb5f19cb9e63694c287 Mon Sep 17 00:00:00 2001 From: Matt White <16320656+matt-FFFFFF@users.noreply.github.com> Date: Thu, 30 Jan 2025 12:16:57 +0000 Subject: [PATCH] chore: minimums and remove text from readme header (#177) --- README.md | 11 ++--------- _header.md | 7 ------- terraform.tf | 4 ++-- 3 files changed, 4 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 5188f81..fb544f5 100644 --- a/README.md +++ b/README.md @@ -12,21 +12,14 @@ Things to do: 1. Configure federated identity credentials on the user assigned managed identity. Use the GitHub environment. 1. Search and update TODOs within the code and remove the TODO comments once complete. -> [!IMPORTANT] -> As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not fully functional and implemented across all supported languages yet - breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated. Hence, modules **MUST NOT** be published at version `1.0.0` or higher at this time. -> -> All module **MUST** be published as a pre-release version (e.g., `0.1.0`, `0.1.1`, `0.2.0`, etc.) until the AVM framework becomes GA. -> -> However, it is important to note that this **DOES NOT** mean that the modules cannot be consumed and utilized. They **CAN** be leveraged in all types of environments (dev, test, prod etc.). Consumers can treat them just like any other IaC module and raise issues or feature requests against them as they learn from the usage of the module. Consumers should also read the release notes for each version, if considering updating to a more recent version of a module to see if there are any considerations or breaking changes etc. - ## Requirements The following requirements are needed by this module: -- [terraform](#requirement\_terraform) (~> 1.5) +- [terraform](#requirement\_terraform) (>= 1.9, < 2.0) -- [azurerm](#requirement\_azurerm) (~> 3.71) +- [azurerm](#requirement\_azurerm) (~> 4.0) - [modtm](#requirement\_modtm) (~> 0.3) diff --git a/_header.md b/_header.md index 518d2f6..2749c90 100644 --- a/_header.md +++ b/_header.md @@ -10,10 +10,3 @@ Things to do: 1. Create a role assignment for the managed identity on your test subscription, use the minimum required role. 1. Configure federated identity credentials on the user assigned managed identity. Use the GitHub environment. 1. Search and update TODOs within the code and remove the TODO comments once complete. - -> [!IMPORTANT] -> As the overall AVM framework is not GA (generally available) yet - the CI framework and test automation is not fully functional and implemented across all supported languages yet - breaking changes are expected, and additional customer feedback is yet to be gathered and incorporated. Hence, modules **MUST NOT** be published at version `1.0.0` or higher at this time. -> -> All module **MUST** be published as a pre-release version (e.g., `0.1.0`, `0.1.1`, `0.2.0`, etc.) until the AVM framework becomes GA. -> -> However, it is important to note that this **DOES NOT** mean that the modules cannot be consumed and utilized. They **CAN** be leveraged in all types of environments (dev, test, prod etc.). Consumers can treat them just like any other IaC module and raise issues or feature requests against them as they learn from the usage of the module. Consumers should also read the release notes for each version, if considering updating to a more recent version of a module to see if there are any considerations or breaking changes etc. diff --git a/terraform.tf b/terraform.tf index 681d4cc..9f095b5 100644 --- a/terraform.tf +++ b/terraform.tf @@ -1,10 +1,10 @@ terraform { - required_version = "~> 1.5" + required_version = ">= 1.9, < 2.0" required_providers { # TODO: Ensure all required providers are listed here and the version property includes a constraint on the maximum major version. azurerm = { source = "hashicorp/azurerm" - version = "~> 3.71" + version = "~> 4.0" } modtm = { source = "azure/modtm"