Azure Verified Modules
Glossary GitHub GitHub Issues Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Last updated: 23 Jan 2024

Process Overview

This page provides an overview of the contribution process for AVM modules.

New Module Proposal & Creation

Each AVM module MUST have a Module Proposal issue created and approved by the AVM core team before it can be created/migrated!
flowchart TD
    ModuleIdea[Consumer has an idea for a new AVM Module] -->CheckIndex(Check AVM Module Indexes)
    CheckIndex -->IndexExistenceCheck{Does the module already 
exist in an active/orphaned
state in respective index?} IndexExistenceCheck -->|No|A IndexExistenceCheck -->|Yes|EndExistenceCheck(Review existing/proposed AVM module) EndExistenceCheck -->OrphanedCheck{Is the module orphaned?} OrphanedCheck -->|No|ContactOwner[Contact module owner,
via GitHub issues on the related
repo, to discuss enhancements/
bugs/opportunities to contribute etc.] OrphanedCheck -->|Yes|OrphanOwnerYes(Locate the related issue
and comment on:
- A feature/enhancement suggestion
- Indicating you wish to become the owner) OrphanOwnerYes -->B A[[Create Module Proposal]] -->|GitHub Issue/Form Submitted| B{AVM Core Team Triage} B -->|Module Approved for Creation| C[["Module Owner(s) Identified &
assigned to GitHub issue/proposal" ]] B -->|Module Rejected| D(Issue closed with reasoning) C -->E[[Module index CSV files
updated by AVM Core Team]] E -->E1[[Repo/Directory Created
Following Contribution Guide]] E1 -->F("Module Developed by
Owner(s) & their Contributors") F -->G[[Module & AVM Compliance Tests]] G -->|Tests Fail|I(Modules/Tests Fixed
To Make Them Pass) I -->F G -->|Tests Pass|J[[Pre-Release v0.1.0 created]] J -->K[[Publish to Bicep/Terraform Registry]] K -->L(Take Feedback from v0.1.0 Consumers) L -->M{Anything to be resolved
before 1.0.0 release?

! Read the AVM preview notice !} M -->|Yes|FixPreV1("Module Feedback Incorporated by
Owner(s) & their Contributors") FixPreV1 -->PreV1Tests[[Self & AVM Module Tests]] PreV1Tests -->|Tests Fail|PreV1TestsFix(Modules/Tests Fixed
To Make Them Pass) PreV1TestsFix -->N M -->|No|N[[Publish 1.0.0 Release]] N -->O[[Publish to IaC Registry]] O -->P[[Module BAU Starts]]

AVM Preview Notice

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.

Module Owner Has Issue/Is Blocked/Has A Request

In the event that a module owner has an issue or is blocked due to specific AVM missing guidance, test environments, permission requirements, etc. they should follow the below steps:

Common issues/blockers/asks/request are:

  • Subscription level features
  • Resource Provider Registration
  • Preview Services Enablement
  • Entra ID (formerly Azure Active Directory) configuration (SPN creation, etc.)
  1. Create a GitHub Issue
  2. Discuss the issue/blocker with the AVM core team
  3. Agree upon action/resolution/closure
  4. Implement agreed upon action/resolution/closure
Please note for module specific issues, these should be logged in the module’s source repository, not the AVM repository.