You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/help-support/issue-triage/avm-issue-triage.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -230,7 +230,7 @@ To look for Orphaned Modules:
230
230
- Add the <markstyle="background-image:none;white-space: nowrap;background-color:#C8E6C9;">Status: Module Available 🟢</mark> and <markstyle="background-image:none;white-space: nowrap;background-color:#FBEF2A;">Status: Owners Identified 🤘</mark> labels to the issue.
231
231
- Move the issue into the "`Done`" column on the [AVM - Modules Triage](https://aka.ms/avm/moduletriage) GitHub Project board.
232
232
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).
233
-
4. Get the new owner(s) and any new contributor(s) added to the related `-module-owners-`or `-module-contributors-` teams as applicable. See [SNFR20]({{% siteparam base %}}/spec/SNFR20) for more details.
233
+
4. Get the new owner(s) added to the related `-module-owners-`team as applicable. See [SNFR20]({{% siteparam base %}}/spec/SNFR20) for more details.
234
234
5. Remove the information notice (i.e., the file that states that `⚠️THIS MODULE IS CURRENTLY ORPHANED.⚠️, etc.` ):
235
235
- In case of a Bicep module:
236
236
- Delete the `ORPHANED.md` file from the module's root.
@@ -276,13 +276,12 @@ If a module meets the criteria described in the "[Deprecated Modules]({{% sitepa
276
276
1. Remove the module from the [`CODEOWNERS`](https://github.com/Azure/bicep-registry-modules/blob/main/.github/CODEOWNERS) file.
277
277
1. Submit a Pull Request
278
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.
279
-
7. Delete the module's `-owners-`and `-contributors-`GitHub teams.
279
+
7. Delete the module's `-owners-` GitHub teams.
280
280
281
281
**Terraform specific steps**
282
282
283
283
4. Place the information notice - with the text below - in the `README.md` file, in the module's root.
284
284
5. Archive the module's repository on GitHub.
285
-
6. Keep the module's `-owners-` and `-contributors-` GitHub teams, as these will keep granting access to the source code of the module.
286
285
287
286
**Deprecation information notice** (to be place in the module's repository as described above)
Copy file name to clipboardExpand all lines: docs/content/specs-defs/includes/shared/shared/non-functional/SNFR20.md
+28-44Lines changed: 28 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,69 +22,66 @@ priority: 1110
22
22
23
23
All GitHub repositories that AVM module are published from and hosted within **MUST** only assign GitHub repository permissions to GitHub teams only.
24
24
25
-
Each module **MUST** have separate GitHub teams assigned for module owners**AND** module contributors respectively. These GitHub teams**MUST** be created in the [Azure organization](https://github.com/orgs/Azure/teams) in GitHub.
25
+
Each module **MUST** have a GitHub team assigned for module owners. This team**MUST** be created in the [Azure organization](https://github.com/orgs/Azure/teams) in GitHub.
26
26
27
27
There **MUST NOT** be any GitHub repository permissions assigned to individual users.
28
28
29
+
{{% notice style="important" %}}
30
+
Non-FTE / external contributors (subject matter experts that aren't Microsoft employees) can't be members of the teams described in this chapter, hence, they won't gain any extra permissions on AVM repositories, therefore, they need to work in forks.
31
+
{{% /notice %}}
32
+
33
+
### Bicep
34
+
29
35
{{% notice style="note" %}}
30
36
The names for the GitHub teams for each approved module are already defined in the respective [Module Indexes]({{% siteparam base %}}/indexes/). These teams **MUST** be created (and used) for each module.
31
37
32
38
-[Bicep Resource Modules]({{% siteparam base %}}/indexes/bicep/bicep-resource-modules/#module-name-telemetry-id-prefix-github-teams-for-owners)
33
39
-[Bicep Pattern Modules]({{% siteparam base %}}/indexes/bicep/bicep-pattern-modules/#module-name-telemetry-id-prefix-github-teams-for-owners)
34
-
-[Terraform Resource Modules]({{% siteparam base %}}/indexes/terraform/tf-resource-modules/#module-name-telemetry-id-prefix-github-teams-for-owners)
35
-
-[Terraform Pattern Modules]({{% siteparam base %}}/indexes/terraform/tf-pattern-modules/#module-name-telemetry-id-prefix-github-teams-for-owners)
40
+
-[Bicep Utility Modules]({{% siteparam base %}}/indexes/bicep/bicep-utility-modules/#module-name-telemetry-id-prefix-github-teams-for-owners)
36
41
37
42
The `@Azure` prefix in the last column of the tables linked above represents the "Azure" GitHub organization all AVM-related repositories exist in. **DO NOT** include this segment in the team's name!
38
43
39
44
{{% /notice %}}
40
45
41
-
{{% notice style="important" %}}
42
-
Non-FTE / external contributors (subject matter experts that aren't Microsoft employees) can't be members of the teams described in this chapter, hence, they won't gain any extra permissions on AVM repositories, therefore, they need to work in forks.
43
-
{{% /notice %}}
44
46
45
-
### Naming Convention
46
47
47
-
The naming convention for the GitHub teams **MUST** follow the below pattern:
48
+
#### Naming Convention
48
49
49
-
-`<hyphenated module name>-module-owners-<bicep/tf>` - to grant permissions for module owners
50
-
-`<hyphenated module name>-module-contributors-tf` - to grant permissions for module contributors (for Terraform modules only)
50
+
The naming convention for the GitHub teams **MUST** follow the below pattern:
51
51
52
-
{{% notice style="note" %}}
53
-
The naming convention for Bicep modules is slightly different than the naming convention for their respective GitHub teams.
54
-
{{% /notice %}}
52
+
-`<hyphenated module name>-module-owners-bicep` - to grant permissions for module owners on Bicep modules
55
53
56
54
Segments:
57
55
58
56
-`<hyphenated module name>` == the AVM Module's name, with each segment separated by dashes, i.e., `avm-res-<resource provider>-<ARM resource type>`
59
57
- See [RMNFR1]({{% siteparam base %}}/spec/RMNFR1) for AVM Resource Module Naming
60
58
- See [PMNFR1]({{% siteparam base %}}/spec/PMNFR1) for AVM Pattern Module Naming
61
-
-`module-owners`or `module-contributors`== the role the GitHub Team is assigned to
62
-
-`<bicep/tf>` == the language the module is written in
59
+
-`module-owners` == the role the GitHub Team is assigned to
60
+
-`<bicep` == the language the module is written in
All officially documented module owner(s) **MUST** be added to the `-module-owners-` team. The `-module-owners-` team **MUST NOT** have any other members.
66
+
{{% notice style="note" %}}
67
+
The naming convention for Bicep modules is slightly different than the naming convention for their respective GitHub teams.
68
+
{{% /notice %}}
72
69
73
-
In case of Terraform modules, any additional module contributors whom the module owner(s) agreed to work with **MUST** be added to the `-module-contributors-` team.
70
+
#### Add Team Members
74
71
75
-
Unless explicitly requested and agreed, members of the AVM core team or any PG teams **MUST NOT** be added to the `-module-owners-`or `-module-contributors-`teams as permissions for them are granted through the teams described in [SNFR9]({{% siteparam base %}}/spec/SNFR9).
72
+
All officially documented module owner(s) **MUST** be added to the `-module-owners-`team. The `-module-owners-`team **MUST NOT** have any other members.
76
73
77
-
### Grant Permissions - Bicep
74
+
Unless explicitly requested and agreed, members of the AVM core team or any PG teams **MUST NOT** be added to the `-module-owners-` teams as permissions for them are granted through the teams described in [SNFR9]({{% siteparam base %}}/spec/SNFR9).
78
75
79
-
###Team memberships
76
+
#### Grant permissions through team memberships
80
77
81
78
{{% notice style="note" %}}
82
79
83
-
In case of Bicep modules, permissions to the [BRM](https://aka.ms/BRM) repository (the repo of the Bicep Registry) are granted via assigning the `-module-owners-`and `-module-contributors-`teams to parent teams that already have the required level access configured. While it is the module owner's responsibility to initiate the addition of their teams to the respective parents, only the AVM core team can approve this parent-child relationship.
80
+
In case of Bicep modules, permissions to the [BRM](https://aka.ms/BRM) repository (the repo of the Bicep Registry) are granted via assigning the `-module-owners-` teams to parent teams that already have the required level access configured. While it is the module owner's responsibility to initiate the addition of their team to the respective parent, only the AVM core team can approve this parent-child relationship.
84
81
85
82
{{% /notice %}}
86
83
87
-
Module owners **MUST** create their `-module-owners-` team and as part of the provisioning process, they **MUST** request the addition of this team to its respective parent teams (see the table below for details).
84
+
Module owners **MUST** create their `-module-owners-` team and as part of the provisioning process, they **MUST** request the addition of this team to its respective parent team (see the table below for details).
88
85
89
86
| GitHub Team Name | Description | Permissions | Permissions granted through | Where to work? |
@@ -106,7 +103,7 @@ Fill in the values as follows:
106
103
-**Team notifications**: `Enabled`
107
104
{{% /notice %}}
108
105
109
-
### CODEOWNERS file
106
+
####CODEOWNERS file
110
107
111
108
As part of the "initial Pull Request" (that publishes the first version of the module), module owners **MUST** add an entry to the `CODEOWNERS` file in the BRM repository ([here](https://github.com/Azure/bicep-registry-modules/blob/main/.github/CODEOWNERS)).
112
109
@@ -124,23 +121,10 @@ Example - `CODEOWNERS` entry for the Bicep resource module of Azure Virtual Netw
Module owners **MUST** assign the `-module-owners-`and `-module-contributors-` teams the necessary permissions on their Terraform module repository per the guidance below.
124
+
### Terraform
130
125
131
-
| GitHub Team Name | Description | Permissions | Permissions granted through | Where to work? |
|`<module name>-module-owners-tf`| AVM Terraform Module Owners - \<module name> |**Admin**| Direct assignment to repo | Module owner can decide whether they want to work in a branch local to the repo or in a fork. |
134
-
|`<module name>-module-contributors-tf`| AVM Terraform Module Contributors - \<module name> |**Write**| Direct assignment to repo | Need to work in a fork. |
135
-
136
-
{{% notice style="tip" %}}
137
-
Direct link to create a new GitHub team: [Create new team](https://github.com/orgs/Azure/new-team)
138
-
139
-
Fill in the values as follows:
140
-
141
-
-**Team name**: Following the naming convention described above, use the value defined in the module indexes.
142
-
-**Description**: Follow the guidance above (see the Description column in the table above).
143
-
-**Parent team**: Do not assign the team to any parent team.
144
-
-**Team visibility**: `Visible`
145
-
-**Team notifications**: `Enabled`
126
+
{{% notice style="note" %}}
127
+
Access management for Terraform repositories has been changed to...
146
128
{{% /notice %}}
129
+
130
+
Permissions in case of Terraform repositories are granted through...
0 commit comments