search

Azure / Azure-Verified-Modules

Azure Verified Modules (AVM) is an initiative to consolidate and set the standards for what a good Infrastructure-as-Code module looks like. Modules will then align to these standards, across languages (Bicep, Terraform etc.) and will then be classified as AVMs and available from their respective language specific registries.
https://aka.ms/AVM
MIT License
348 stars 82 forks source link

[Feedback]: It would be worth standardising the module version reference #1320

Open Dipak-Mistry-WTW opened 2 months ago

Dipak-Mistry-WTW commented 2 months ago

Check for previous/existing GitHub issues

Description

I use a fair few avm modules and have noticed a little discrepancy in formatting the github reference. Some have a "v" and some do not. It's only minor but its noticeable when tying do to a particular module version.

These have a v in the version reference: https://github.com/Azure/terraform-azurerm-avm-res-operationalinsights-workspace.git?ref=v0.3.4 https://github.com/Azure/terraform-azurerm-avm-res-databricks-workspace.git?ref=0.2.0 https://github.com/Azure/terraform-azurerm-avm-res-network-networksecuritygroup.git?ref=v0.2.0 https://github.com/Azure/terraform-azurerm-avm-res-keyvault-vault.git?ref=v0.7.3 https://github.com/Azure/terraform-azurerm-avm-res-network-natgateway.git?ref=v0.2.0 https://github.com/Azure/terraform-azurerm-avm-res-network-virtualnetwork.git?ref=v0.4.0 https://github.com/Azure/terraform-azurerm-avm-res-network-privatednszone.git?ref=v0.1.2 https://github.com/Azure/terraform-azurerm-avm-res-storage-storageaccount.git?ref=v0.2.2

These do not: https://github.com/Azure/terraform-azurerm-avm-res-databricks-workspace.git?ref=0.2.0 https://github.com/Azure/terraform-azurerm-avm-res-managedidentity-userassignedidentity.git?ref=0.3.2

I don't care which is chosen but would be nice to standardise.

microsoft-github-policy-service[bot] commented 2 months ago

[!IMPORTANT] The "Needs: Triage :mag:" label must be removed once the triage process is complete!

[!TIP] For additional guidance on how to triage this issue/PR, see the AVM Issue Triage documentation.

matebarabas commented 1 month ago

@Dipak-Mistry-WTW, thank you for your patience!

@matt-FFFFFF, can you please take a look at this? Thanks!

jaredfholgate commented 1 month ago

It appears although we show the example without the v we do not specify one or the other: https://azure.github.io/Azure-Verified-Modules/contributing/terraform/terraform-contribution-flow/owner-contribution-flow/#7-publish-the-module

The HashiCorp guidance does not have an opinion either: https://developer.hashicorp.com/terraform/registry/modules/publish#requirements

It seems most people have settled on the v, so we should probably mandate that moving forwards and see if we can backfill the ones without a v to have a v tag on the same commits.

jaredfholgate commented 1 month ago

Having said that, it makes no difference in the Terraform registry and how you reference a module, so not critical. But I agree we should be consistent and probably introduce a release workflow at some point.

Dipak-Mistry-WTW commented 1 month ago

I’m happy to close the issue. It was just to bring it to your attention. Thanks