Azure / Azure/ResourceModules

Wiki - Add versioning guidance for modules

Open
#1,300 3 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
PowerShell
Stars
737
Forks
436
Avg merge
10d 7h
Merged PRs (30d)
1

Description

### Description

Some discussion had in the team which is not clearly addressed. What change causes an increment of the different versions when publishing a module?

Write a draft, discuss with the team and adding guidance in the wiki for when to increment the version of IaC modules in the case of:
- breaking change (major update)
- feature change (minor update)
- bug/hot fix (patch update) for IaC modules.

Things to consider would primarily be parameter and output changes + vital changes in behavior for the module itself, such as (but not limited to):

- Adding a new required parameter.
- Adding a new optional parameter.
- Changing an optional parameter to required or vica verca. (adding or removing default values)
- Removing a parameter (optional or required) or output.
- Changing data type of a parameter or output.
- Changing name of a parameter or output.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.