Azure / Azure/Azure-Verified-Modules

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

Open
#1,620 3 comments 0 reactions 0 assignees View on GitHub
Language: Bicep :muscle: Status: In Triage :mag: Type: Documentation :page_facing_up:
Dominant language
PowerShell
Stars
580
Forks
161
Avg merge
11h 3m
Merged PRs (30d)
15

Description

### Check for previous/existing GitHub issues

- [x] I have checked 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"
]
}

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.