Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/content/contributing/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ flowchart TD
click G "{{% siteparam base %}}/spec/SNFR3"
G -->|Tests Fail|I(Modules/Tests Fixed <br> To Make Them Pass)
I -->F
G -->|Tests Pass|J[[Pre-Release v0.1.0 created]]
G -->|Tests Pass|J[[Version 0.1.0 created]]
J -->K[[Publish to Bicep/Terraform Registry]]
K -->L(Take Feedback from v0.1.0 Consumers)
L -->M{Anything<br>to be resolved <br> before 1.0.0<br>release? }
Expand All @@ -80,9 +80,9 @@ When proposing a module, please include the information in the description that

{{% notice style="important" %}}

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.
The AVM framework continues to evolve, and several elements, such as Continuous Integration (CI) processes, module specifications and corresponding specification‑validation coverage, are not yet fully implemented. 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.
All module **MUST** be published as a `0.x.y` minor version (e.g., `0.1.0`, `0.1.1`, `0.2.0`, etc.) until the AVM team provides guidance that publishing v1.0.0 is allowed.

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.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/contributing/terraform/review.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Thank you for requesting a review of your module. The AVM module review process

{{< highlight lineNos="false" type="markdown" wrap="true" title="" >}}

Thank you for contributing this module and completing the review process per AVM specs. The AVM-Review-PR has been approved and once you merge it that will close this AVM-Review issue. You may proceed with [publishing]({{% siteparam base %}}/contributing/terraform/terraform-contribution-flow/owner-contribution-flow/#7-publish-the-module) this module to the HashiCorp Terraform Registry with an initial pre-release version of v0.1.0. Please keep future versions also pre-release i.e. < 1.0.0 until AVM becomes generally available (GA) of which the AVM team will notify you.
Thank you for contributing this module and completing the review process per AVM specs. The AVM-Review-PR has been approved and once you merge it that will close this AVM-Review issue. You may proceed with [publishing]({{% siteparam base %}}/contributing/terraform/terraform-contribution-flow/owner-contribution-flow/#7-publish-the-module) this module to the HashiCorp Terraform Registry with an initial minor version of v0.1.0. Please continue publishing future versions in the 0.x.y minor range (e.g., 0.1.0, 0.1.1, 0.2.0, etc.) until the AVM team notifies you that publishing v1.0.0 is allowed.

**Requested Action**: Once published please update your [module proposal](REPLACE WITH THE LINK TO THE MODULE PROPOSAL) with the following comment.

Expand Down
6 changes: 3 additions & 3 deletions docs/content/resources/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,11 +323,11 @@ For Microsoft FTEs only: see the **Internal** wiki for support workflow for more

---

### Can AVM module be used in production before it is marked as "GA" / v1.0?
### Can AVM modules be used in production before they are marked as v1.0?

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.
The AVM framework continues to evolve, and several elements, such as Continuous Integration (CI) processes, module specifications and corresponding specification‑validation coverage, are not yet fully implemented. For this reason, modules are currently published as `0.x.y` minor versions (e.g., `0.1.0`, `0.1.1`, `0.2.0`, etc.).

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.
However, a module does not need to be at version `1.0.0` to be considered production ready. Consumers can use these modules in any environment, including production. Consumers can also raise issues or feature requests as they learn from the usage of the module, and rely on the detailed changelog files (Bicep) and release notes (Terraform) when assessing whether to upgrade to a newer version. Once a module reaches v1.0, semantic versioning will apply fully: breaking changes will be avoided whenever possible, but if they become necessary, they will be introduced through a major version increment.

---

Expand Down