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
Original file line number Diff line number Diff line change
Expand Up @@ -23,27 +23,25 @@ Additional internal content for **ongoing module maintenance** available for Mic

Familiarise yourself with the responsibilities as **Module Owner** outlined in [Team Definitions & RACI]({{% siteparam base %}}/specs/shared/team-definitions/#module-owners) and [Module Owner Responsibilities]({{% siteparam base %}}/help-support/issue-triage/brm-issue-triage/#module-owner-responsibilities) in the [BRM Issue Triage]({{% siteparam base %}}/help-support/issue-triage/brm-issue-triage/).

1. Create GitHub teams as outlined in [SNFR20]({{% siteparam base %}}/spec/SNFR20) and add respective parent teams:
1. Create a GitHub team as outlined in [SNFR20]({{% siteparam base %}}/spec/SNFR20) and add it to the respective parent team:

Segments:
Naming convention:

- `avm-res-<RP>-<modulename>-module-owners-bicep`
- `avm-res-<RP>-<modulename>-module-contributors-bicep`

Examples:
Example:

- `avm-res-compute-virtualmachine-module-owners-bicep` and added `avm-technical-reviewers-bicep` as parent.
- `avm-res-compute-virtualmachine-module-contributors-bicep` and added `avm-module-contributors-bicep` as parent.

If a secondary owner is required, add the secondary owner to the `avm-res-<RP>-<modulename>-module-owners-bicep` team.
If a secondary or any additional owner is required, add them to the `avm-res-<RP>-<modulename>-module-owners-bicep` team.

Only fulltime Microsoft employees can be added at this time.

{{% notice style="info" %}}
Once the teams have been created the AVM Core Team will review the team name and parent team membership for accuracy. A notification will automatically be sent to the AVM Core Team to inform them that their review needs to be completed.
Once the team have been created the AVM Core Team will review the team name and parent team membership for accuracy. A notification will automatically be sent to the AVM Core Team to inform them that their review needs to be completed.
{{% /notice %}}

2. Add teams to `CODEOWNERS` file as outlined in [SNFR20]({{% siteparam base %}}/spec/SNFR20).
2. Add the `-owners-` team to `CODEOWNERS` file as outlined in [SNFR20]({{% siteparam base %}}/spec/SNFR20).
3. Ensure your module has been tested before raising a PR. You can do this your own or in another module contributor's environment - if any. Also, once a PR is raised, a GitHub workflow pipeline is required to be run successfully before the PR can be merged. This is to ensure that the module is working as expected and is compliant with the AVM specifications.
{{% notice style="note" %}}

Expand All @@ -59,8 +57,8 @@ If you're the **sole owner of the module**, the **AVM core team must review and
Under certain circumstances, you may find yourself unable to continue as the module owner. In such cases, it is advisable to designate a new module owner. The following steps outline this transition:

- Leave a comment on the original module proposal, indicating that you'd like to hand the ownership over to somebody else. Mention the person who originally helped triage the issue or the `@Azure/avm-core-team-technical-bicep` team. You must wait for someone from the AVM Core Team to respond first, as the module index must be updated before you can continue handing over the ownership.
- Add the new owner's GitHub account as a "maintainer" on your modules GitHub teams.
- Remove your GitHub account from your module's GitHub teams.
- Add the new owner's GitHub account as a "maintainer" on your modules GitHub team.
- Remove your GitHub account from your module's GitHub team.

If a new module owner cannot be identified then the module will need to be "Orphaned". Please follow the step outlined [when-a-module-becomes-orphaned]({{% siteparam base %}}/help-support/issue-triage/avm-issue-triage/#when-a-module-becomes-orphaned).

Expand Down
9 changes: 4 additions & 5 deletions docs/content/help-support/issue-triage/avm-issue-triage.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@ Although, it's not directly part of the module proposal triage process, to begin

1. Update any Azure RBAC permissions for test tenants/subscription, if needed.
2. In case of **Bicep modules** only:
- Look for the module owners confirmation on the related `[Module Proposal]` issue that they have created the required `-module-owners-` and `-module-contributors-` GitHub teams.
- Ensure the `-module-owners-` and `-module-contributors-` GitHub teams have been assigned to their respective parent teams as outlined [here]({{% siteparam base %}}/spec/snfr20/#grant-permissions---bicep).
- Look for the module owners confirmation on the related `[Module Proposal]` issue that they have created the required `-module-owners-` GitHub team.
- Ensure the `-module-owners-` GitHub team has been assigned to its respective parent team as outlined [here]({{% siteparam base %}}/spec/snfr20/#grant-permissions---bicep).
- Ensure the [`CODEOWNERS`](https://github.com/Azure/bicep-registry-modules/blob/main/.github/CODEOWNERS) file in the [BRM repo](https://aka.ms/BRM) has been updated.
- Ensure the [`AVM Module Issue template`](https://github.com/Azure/bicep-registry-modules/blob/main/.github/ISSUE_TEMPLATE/avm_module_issue.yml) file in the [BRM repo](https://aka.ms/BRM) has been updated.

Expand Down Expand Up @@ -230,7 +230,7 @@ To look for Orphaned Modules:
- Add the &nbsp;<mark style="background-image:none;white-space: nowrap;background-color:#C8E6C9;">Status: Module Available 🟢</mark>&nbsp; and &nbsp;<mark style="background-image:none;white-space: nowrap;background-color:#FBEF2A;">Status: Owners Identified 🤘</mark>&nbsp; labels to the issue.
- Move the issue into the "`Done`" column on the [AVM - Modules Triage](https://aka.ms/avm/moduletriage) GitHub Project board.
3. Update the AVM Module Indexes, following the [process documented internally](https://dev.azure.com/CSUSolEng/Azure%20Verified%20Modules/_wiki/wikis/AVM%20Internal%20Wiki/684/Module-index-update-process).
4. Get the new owner(s) and any new contributor(s) added to the related `-module-owners-` or `-module-contributors-` teams. See [SNFR20]({{% siteparam base %}}/spec/SNFR20) for more details.
4. Get the new owner(s) added to the related `-module-owners-` team as applicable. See [SNFR20]({{% siteparam base %}}/spec/SNFR20) for more details.
5. Remove the information notice (i.e., the file that states that `⚠️THIS MODULE IS CURRENTLY ORPHANED.⚠️, etc.` ):
- In case of a Bicep module:
- Delete the `ORPHANED.md` file from the module's root.
Expand Down Expand Up @@ -276,13 +276,12 @@ If a module meets the criteria described in the "[Deprecated Modules]({{% sitepa
1. Remove the module from the [`CODEOWNERS`](https://github.com/Azure/bicep-registry-modules/blob/main/.github/CODEOWNERS) file.
1. Submit a Pull Request
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.
7. Delete the module's `-owners-` and `-contributors-` GitHub teams.
7. Delete the module's `-owners-` GitHub teams.

**Terraform specific steps**

4. Place the information notice - with the text below - in the `README.md` file, in the module's root.
5. Archive the module's repository on GitHub.
6. Keep the module's `-owners-` and `-contributors-` GitHub teams, as these will keep granting access to the source code of the module.

**Deprecation information notice** (to be place in the module's repository as described above)

Expand Down
6 changes: 3 additions & 3 deletions docs/content/indexes/bicep/bicep-pattern-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@ Modules listed below that aren't shown with the status of **`Module Available

{{% notice style="note" %}}

This section is mainly intended **for module owners and contributors** as it contains information important for module development, such as **telemetry ID prefix, and GitHub Teams for Owners & Contributors**.
This section is mainly intended **for module owners and contributors** as it contains information important for module development, such as **telemetry ID prefix, and GitHub Teams for Owners**.

{{% /notice %}}

### Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
### Module name, Telemetry ID prefix, GitHub Teams for Owners

{{% expand title="➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" expanded="false" %}}
{{% expand title="➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners" expanded="false" %}}

{{% moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/BicepPatternModules.csv" language="Bicep" moduleType="pattern" %}}

Expand Down
6 changes: 3 additions & 3 deletions docs/content/indexes/bicep/bicep-resource-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,13 @@ Modules listed below that aren't shown with the status of **`Module Available

{{% notice style="note" %}}

This section is mainly intended **for module owners and contributors** as it contains information important for module development, such as **telemetry ID prefix, and GitHub Teams for Owners & Contributors**.
This section is mainly intended **for module owners and contributors** as it contains information important for module development, such as **telemetry ID prefix, and GitHub Teams for Owners**.

{{% /notice %}}

### Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
### Module name, Telemetry ID prefix, GitHub Teams for Owners

{{% expand title="➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" expanded="false" %}}
{{% expand title="➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners" expanded="false" %}}

{{% moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/BicepResourceModules.csv" language="Bicep" moduleType="resource" %}}

Expand Down
6 changes: 3 additions & 3 deletions docs/content/indexes/bicep/bicep-utility-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,13 @@ Modules listed below that aren't shown with the status of **`Module Available

{{% notice style="note" %}}

This section is mainly intended **for module owners and contributors** as it contains information important for module development, such as **telemetry ID prefix, and GitHub Teams for Owners & Contributors**.
This section is mainly intended **for module owners and contributors** as it contains information important for module development, such as **telemetry ID prefix, and GitHub Teams for Owners**.

{{% /notice %}}

### Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors
### Module name, Telemetry ID prefix, GitHub Teams for Owners

{{% expand title="➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" expanded="false" %}}
{{% expand title="➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners" expanded="false" %}}

{{% moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/BicepUtilityModules.csv" language="Bicep" moduleType="utility" %}}

Expand Down
16 changes: 0 additions & 16 deletions docs/content/indexes/terraform/tf-pattern-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,19 +73,3 @@ Modules listed below that aren't shown with the status of **`Module Available
{{% moduleHistory header=true csv="/static/module-indexes/TerraformPatternModules.csv" language="Terraform" moduleType="pattern" exclude="Proposed" monthsToShow=9999 %}}

{{% /expand %}}

## For Module Owners & Contributors

{{% notice style="note" %}}

This section is mainly intended **for module owners and contributors** as it contains information about the **GitHub Teams for Owners & Contributors**.

{{% /notice %}}

### Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors

{{% expand title="➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" expanded="false" %}}

{{% moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/TerraformPatternModules.csv" language="Terraform" moduleType="pattern"%}}

{{% /expand %}}
16 changes: 0 additions & 16 deletions docs/content/indexes/terraform/tf-resource-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,19 +73,3 @@ Modules listed below that aren't shown with the status of **`Module Available
{{% moduleHistory header=true csv="/static/module-indexes/TerraformResourceModules.csv" language="Terraform" moduleType="resource" exclude="Proposed" monthsToShow=9999 %}}

{{% /expand %}}

## For Module Owners & Contributors

{{% notice style="note" %}}

This section is mainly intended **for module owners and contributors** as it contains information about the **GitHub Teams for Owners & Contributors**.

{{% /notice %}}

### Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors

{{% expand title="➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" expanded="false" %}}

{{% moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/TerraformResourceModules.csv" language="Terraform" moduleType="resource" %}}

{{% /expand %}}
16 changes: 0 additions & 16 deletions docs/content/indexes/terraform/tf-utility-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,19 +73,3 @@ Modules listed below that aren't shown with the status of **`Module Available
{{% moduleHistory header=true csv="/static/module-indexes/TerraformUtilityModules.csv" language="Terraform" moduleType="utility" exclude="Proposed" monthsToShow=9999 %}}

{{% /expand %}}

## For Module Owners & Contributors

{{% notice style="note" %}}

This section is mainly intended **for module owners and contributors** as it contains information about the **GitHub Teams for Owners & Contributors**.

{{% /notice %}}

### Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors

{{% expand title="➕ All Modules - Module name, Telemetry ID prefix, GitHub Teams for Owners & Contributors" expanded="false" %}}

{{% moduleNameTelemetryGHTeams header=true csv="/static/module-indexes/TerraformUtilityModules.csv" language="Terraform" moduleType="utility"%}}

{{% /expand %}}
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The following information notice is automatically added at the bottom of the `RE
### Bicep

{{% notice style="important" %}}
The value you need to use for your module is defined in the related module index. You can look it up on the index pages for [Resource Modules]({{% siteparam base %}}/indexes/bicep/bicep-resource-modules/#module-name-telemetry-id-prefix-github-teams-for-owners--contributors), [Pattern Modules]({{% siteparam base %}}/indexes/bicep/bicep-pattern-modules/#module-name-telemetry-id-prefix-github-teams-for-owners--contributors) and [Utility Modules]({{% siteparam base %}}/indexes/bicep/bicep-utility-modules/#module-name-telemetry-id-prefix-github-teams-for-owners--contributors).
The value you need to use for your module is defined in the related module index. You can look it up on the index pages for [Resource Modules]({{% siteparam base %}}/indexes/bicep/bicep-resource-modules/#module-name-telemetry-id-prefix-github-teams-for-owners), [Pattern Modules]({{% siteparam base %}}/indexes/bicep/bicep-pattern-modules/#module-name-telemetry-id-prefix-github-teams-for-owners) and [Utility Modules]({{% siteparam base %}}/indexes/bicep/bicep-utility-modules/#module-name-telemetry-id-prefix-github-teams-for-owners).
{{% /notice %}}

The ARM deployment name used for the telemetry **MUST** follow the pattern and **MUST** be no longer than 64 characters in length: `46d3xbcp.<res/ptn>.<(short) module name>.<version>.<uniqueness>`
Expand Down
Loading