This pull request includes an important change to the _header.md file. The change modifies the guidelines for versioning and usage of the modules in the 'Things to do' section.
The most significant change is the new instruction on the versioning of modules. Modules should now be published as pre-release versions (e.g., 0.1.0, 0.1.1, 0.2.0, etc.) until the AVM framework becomes generally available (GA). This is due to the fact that the AVM framework is not yet fully functional and implemented across all languages, and breaking changes are expected. However, it is emphasized that this does not prevent the modules from being consumed and utilized in all 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 consumption and usage of the module. They should also read the release notes for each version, if considering updating to a more recently released version of a module to see if there are any considerations or breaking changes etc.
This pull request includes an important change to the
_header.md
file. The change modifies the guidelines for versioning and usage of the modules in the 'Things to do' section.The most significant change is the new instruction on the versioning of modules. Modules should now be published as pre-release versions (e.g.,
0.1.0
,0.1.1
,0.2.0
, etc.) until the AVM framework becomes generally available (GA). This is due to the fact that the AVM framework is not yet fully functional and implemented across all languages, and breaking changes are expected. However, it is emphasized that this does not prevent the modules from being consumed and utilized in all 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 consumption and usage of the module. They should also read the release notes for each version, if considering updating to a more recently released version of a module to see if there are any considerations or breaking changes etc.