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
362 stars 85 forks source link

[Documentation Update]: SNFR17 - Semantic Versioning - version.json #1620

Open jbinko opened 4 weeks ago

jbinko commented 4 weeks ago

Check for previous/existing GitHub issues

Description

I believe we should enhance the clarity of the section on semantic versioning at https://azure.github.io/Azure-Verified-Modules/specs/shared/#id-snfr17---category-release---semantic-versioning. Currently, it outlines the versioning mechanism broadly. We should specify, particularly for Bicep modules, the need for a version.json file, include a template for contributors, and clarify versioning practices. For instance, if the initial module version in the version.json is 0.1.0, contributors should record it as 0.1. This distinction was initially unclear and could lead to confusion.

{ "$schema": "https://aka.ms/bicep-registry-module-version-file-schema#", "version": "0.1", "pathFilters": [ "./main.json" ] }

microsoft-github-policy-service[bot] commented 4 weeks 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.

eriqua commented 3 weeks ago

Hi @jbinko,

From a spec perspective (generic for both DSLs) I see we already specify that Bicep only requires to update major and minor, since patch is automatically updated.

However, from a contribution flow point of view, I agree we can better highlight version update as a dedicated step in the process.

I'd suggest to cover the How in the contribution guide rather then the specs. What's your take on that?

jbinko commented 3 weeks ago

For contributors in Bicep - let's point them into this: https://azure.github.io/Azure-Verified-Modules/specs/bicep/#id-bcpnfr14---category-composition---versioning This is clear one step that they should include one file and with specific content