Skip to content

Commit 975afd4

Browse files
feat: Updated the deprecation guidelines to the latest consensus (#2244)
1 parent 06472df commit 975afd4

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

docs/content/help-support/issue-triage/avm-issue-triage.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -266,18 +266,16 @@ If a module meets the criteria described in the "[Deprecated Modules]({{% sitepa
266266

267267
**Bicep specific steps**
268268

269-
4. Place an information notice as per the below guidelines:
269+
4. Update the module and connected files as per the below guidelines:
270270
1. Place the information notice - with the text below - in an `DEPRECATED.md` file, in the module's root.
271-
1. Add a 'DEPRECATED - ' prefix to the `main.bicep`'s metadata description. For example, `metadata description = 'DEPRECATED - This module deploys a XYZ'` - i.e, add the 'DEPRECATED' prefix while keeping your original description. This description will be displayed to users of the VS-Code Bicep extension when searching for the module.
272-
1. Run the [`utilities/tools/Set-AVMModule.ps1`](https://github.com/Azure/bicep-registry-modules/blob/main/utilities/tools/Set-AVMModule.ps1) utility with the module path as an input. This re-generates the module’s `README.md` file, so that the `README.md` file will also contain the same notice in its header. For more instructions on how to use the script, please refer to the corresponding section in the [Contribution Guide](https://azure.github.io/Azure-Verified-Modules/contributing/bicep/bicep-contribution-flow/generate-bicep-module-files/).
273-
2. Make sure the content of the `DEPRECATED.md` file is displayed in the `README.md` in its header (right after the title).
274-
3. Publish a new patch version, having the updated `README.md` stating the module is deprecated.
275-
5. Once the information notice is placed, submit a Pull Request (the first one of the 2 required).
276-
6. Once the first PR is merged,
271+
1. Run the [`utilities/tools/Set-AVMModule.ps1`](https://github.com/Azure/bicep-registry-modules/blob/main/utilities/tools/Set-AVMModule.ps1) utility with the module path & `-SkipBuild` switch as an input. This re-generates the module’s `README.md` file, so that the `README.md` file will also contain the same notice in its header. For more instructions on how to use the script, please refer to the corresponding section in the [Contribution Guide](https://azure.github.io/Azure-Verified-Modules/contributing/bicep/bicep-contribution-flow/generate-bicep-module-files/).
272+
1. Make sure the content of the `DEPRECATED.md` file is displayed in the `README.md` in its header (right after the title).
273+
1. Add the the notice `NOTE: This is the last published version and the module has since been deprecated.` to the top-most `### Changes` section of the module's `CHANGELOG.md` file
277274
1. Remove the module workflow from the [`workflows`](https://github.com/Azure/bicep-registry-modules/tree/main/.github/workflows) folder.
278-
2. Make sure the module is removed from the [`avm_module_issue.yml`](https://github.com/Azure/bicep-registry-modules/blob/main/.github/ISSUE_TEMPLATE/avm_module_issue.yml) issue template.
279-
3. Remove the module from the [`CODEOWNERS`](https://github.com/Azure/bicep-registry-modules/blob/main/.github/CODEOWNERS) file.
280-
4. Submit a Pull Request (the second and final one of the 2 required)
275+
1. Make sure the module is removed from the [`avm_module_issue.yml`](https://github.com/Azure/bicep-registry-modules/blob/main/.github/ISSUE_TEMPLATE/avm_module_issue.yml) issue template.
276+
1. Remove the module from the [`CODEOWNERS`](https://github.com/Azure/bicep-registry-modules/blob/main/.github/CODEOWNERS) file.
277+
1. Submit a Pull Request
278+
1. For the AVM maintainers: Once the PR is merged, run the [.Platform - Publish [moduleIndex.json]](https://github.com/Azure/bicep-registry-modules/actions/workflows/platform.publish-module-index-json.yml) workflow with the `regenIndexFromBRM` flag set. This will de-list the module so that it won't show up in the VS-Code Bicep extension going forward.
281279
7. Delete the module's `-owners-` and `-contributors-` GitHub teams.
282280

283281
**Terraform specific steps**

0 commit comments

Comments
 (0)