Skip to content

docs: update repo creation process #2150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jaredfholgate merged 1 commit into from
Jun 18, 2025
Merged

docs: update repo creation process #2150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 9 additions & 7 deletions ...ntributing/terraform/terraform-contribution-flow/repository-creation-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ This contribution flow is for **AVM Core Team members** only.
### 2. Create the repository

1. Open a PowerShell terminal
1. Clone the <https://github.com/Azure/terraform-azure-modules> repository and navigate to the `repository_creation_helper` folder
1. Clone the <https://github.com/Azure/avm-terraform-governance> repository and navigate to the `tf-repo-mgmt/repository_creation_helper` folder

```pwsh
git clone "https://github.com/Azure/terraform-azure-modules"
cd ./terraform-azure-modules/repository_creation_helper
git clone "https://github.com/Azure/avm-terraform-governance"
cd ./tf-repo-mgmt/repository_creation_helper
```

1. Install the GitHub CLI if you don't already have it installed: <https://cli.github.com>
Expand All @@ -61,7 +61,6 @@ This contribution flow is for **AVM Core Team members** only.

# Optional Metadata Inputs
$moduleAlternativeNames = "<alternative names>" # Replace with a comma separated list of alternative names for the module
$moduleComments = "<comments>" # Replace with any comments you want to add to the module
$ownerSecondaryGitHubHandle = "<github user handle>" # Replace with the GitHub handle of the module owner
$ownerSecondaryDisplayName = "<user display name>" # Replace with the display name of the module owner

Expand All @@ -74,7 +73,6 @@ This contribution flow is for **AVM Core Team members** only.
-ownerPrimaryGitHubHandle $ownerPrimaryGitHubHandle `
-ownerPrimaryDisplayName $ownerPrimaryDisplayName `
-moduleAlternativeNames $moduleAlternativeNames `
-moduleComments $moduleComments `
-ownerSecondaryGitHubHandle $ownerSecondaryGitHubHandle `
-ownerSecondaryDisplayName $ownerSecondaryDisplayName

Expand All @@ -94,7 +92,6 @@ This contribution flow is for **AVM Core Team members** only.

# Optional Metadata Inputs
$moduleAlternativeNames = "VNet" # Replace with a comma separated list of alternative names for the module
$moduleComments = "" # Replace with any comments you want to add to the module
$ownerSecondaryGitHubHandle = "" # Replace with the GitHub handle of the module owner
$ownerSecondaryDisplayName = "" # Replace with the display name of the module owner

Expand All @@ -107,7 +104,6 @@ This contribution flow is for **AVM Core Team members** only.
-ownerPrimaryGitHubHandle $ownerPrimaryGitHubHandle `
-ownerPrimaryDisplayName $ownerPrimaryDisplayName `
-moduleAlternativeNames $moduleAlternativeNames `
-moduleComments $moduleComments `
-ownerSecondaryGitHubHandle $ownerSecondaryGitHubHandle `
-ownerSecondaryDisplayName $ownerSecondaryDisplayName

Expand Down Expand Up @@ -240,3 +236,9 @@ This contribution flow is for **AVM Core Team members** only.

1. Add the &nbsp;<mark style="background-image:none;white-space: nowrap;background-color:#27AB03;color:white;">Status: Repository Created 📄</mark>&nbsp; label to the issue
1. Remove the &nbsp;<mark style="background-image:none;white-space: nowrap;background-color:#136A41;color:white;">Status: Ready For Repository Creation 📝</mark>&nbsp; label from the issue

### 5. Merge the Pull Request for the metadata CSV file

1. Open the pull request for the metadata CSV file shown in the script output look [here](https://github.com/Azure/avm-terraform-governance/pulls) if you lost the link
1. Review the changes to ensure they are correct and only adding 1 new line for the module you just created
1. If everything looks good, merge the pull request
8 changes: 5 additions & 3 deletions docs/content/help-support/issue-triage/avm-issue-triage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,11 @@ If requestor is interested in becoming a module owner, but is not a Microsoft FT
{{% /notice %}}

1. If the requestor indicated they didn't want to or can't become a module owner (or is not a Microsoft FTE), make sure the &nbsp;<mark style="background-image:none;white-space: nowrap;background-color:#FF0019;color:white;">Needs: Module Owner 📣</mark>&nbsp; label is assigned to the issue. Note: the GitHub Policy Service Bot should automatically do this, based on how the issue author responded to the related question.
2. Move the issue to the "`Looking for owners`" column on the [AVM - Modules Triage](https://aka.ms/avm/moduletriage) GitHub project board.
3. Find module owners - if the requestor didn't volunteer in the module proposal OR the requestor does not want or cannot be owner of the module:
1. Move the issue to the "`Looking for owners`" column on the [AVM - Modules Triage](https://aka.ms/avm/moduletriage) GitHub project board.
1. Add a comment on the issue with the `#RFRC` tag to indicate that the repository should be created. This allows the module to be added the module indexes in the `Proposed` state, so that it can be found by the community and potential module owners.
1. Find module owners - if the requestor didn't volunteer in the module proposal OR the requestor does not want or cannot be owner of the module:
- Try to find an owner from the AVM communities or await a module owner to comment and propose themselves on the proposal issue.
4. When a new potential owner is identified, continue with the steps described [as follows](#scenario-2-requestor-wants-to-and-can-become-module-owner).
1. When a new potential owner is identified, continue with the steps described [as follows](#scenario-2-requestor-wants-to-and-can-become-module-owner).

### Scenario 2: Requestor wants to and can become module owner

Expand All @@ -104,6 +105,7 @@ You **MUST** still confirm that the requestor is a Microsoft FTE and that they u
3. Once module owner identified has confirmed they understand and accept their roles and responsibilities as an AVM module owner
- Make sure the issue is assigned to the confirmed module owner.
- Move the issue into the "`In development`" column on the [AVM - Modules Triage](https://aka.ms/avm/moduletriage) GitHub Project board.
- Add a comment on the issue with the `#RFRC` tag to indicate that the repository should be created. This allows the module to be added the module indexes in the `Proposed` state, so that it can be found by the community.
- Make sure the &nbsp;<mark style="background-image:none;white-space: nowrap;background-color:#FBEF2A;">Status: Owners Identified 🤘</mark>&nbsp; label is added to the issue.
- If applied earlier, remove the &nbsp;<mark style="background-image:none;white-space: nowrap;background-color:#FF0019;color:white;">Needs: Module Owner 📣</mark>&nbsp; label from the issue.
- Remove the labels of &nbsp;<mark style="background-image:none;white-space: nowrap;background-color:#FBCA04;">Needs: Triage 🔍</mark>&nbsp; and &nbsp;<mark style="background-image:none;white-space: nowrap;background-color:#E4E669;">Status: In Triage 🔍</mark>&nbsp; to indicate you're done with triaging the issue.
Expand Down