Skip to content

Commit bb624a5

Browse files
younGihanyounGihan
committed
style: formatting according to pre-commit checks
1 parent 4d0c721 commit bb624a5

File tree

14 files changed

+458
-35
lines changed

14 files changed

+458
-35
lines changed

‎modules/azuredevops/pipeline/backplane/README.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,53 @@ module "azuredevops_pipeline_backplane" {
5353
- Service principal has read-only access to Key Vault secrets
5454
- PAT should be rotated regularly (recommended: every 90 days)
5555
- Use separate backplane instances for different environments
56+
57+
<!-- BEGIN_TF_DOCS -->
58+
## Requirements
59+
60+
| Name | Version |
61+
|------|---------|
62+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
63+
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | ~> 2.53.1 |
64+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~> 3.116.0 |
65+
66+
## Modules
67+
68+
No modules.
69+
70+
## Resources
71+
72+
| Name | Type |
73+
|------|------|
74+
| [azuread_application.azure_devops](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/application) | resource |
75+
| [azuread_service_principal.azure_devops](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/service_principal) | resource |
76+
| [azurerm_key_vault.devops](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault) | resource |
77+
| [azurerm_resource_group.devops](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
78+
| [azurerm_role_assignment.azure_devops_manager](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment) | resource |
79+
| [azurerm_role_definition.azure_devops_manager](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_definition) | resource |
80+
| [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) | data source |
81+
| [azurerm_subscription.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/subscription) | data source |
82+
83+
## Inputs
84+
85+
| Name | Description | Type | Default | Required |
86+
|------|-------------|------|---------|:--------:|
87+
| <a name="input_azure_devops_organization_url"></a> [azure\_devops\_organization\_url](#input\_azure\_devops\_organization\_url) | Azure DevOps organization URL (e.g., https://dev.azure.com/myorg) | `string` | n/a | yes |
88+
| <a name="input_key_vault_name"></a> [key\_vault\_name](#input\_key\_vault\_name) | Name of the Key Vault to store the Azure DevOps PAT | `string` | n/a | yes |
89+
| <a name="input_location"></a> [location](#input\_location) | Azure region for resources | `string` | `"West Europe"` | no |
90+
| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | Resource group name for the Key Vault | `string` | n/a | yes |
91+
| <a name="input_scope"></a> [scope](#input\_scope) | Azure scope for role definitions (subscription or management group) | `string` | n/a | yes |
92+
| <a name="input_service_principal_name"></a> [service\_principal\_name](#input\_service\_principal\_name) | Name for the Azure DevOps service principal | `string` | `"azure-devops-terraform"` | no |
93+
94+
## Outputs
95+
96+
| Name | Description |
97+
|------|-------------|
98+
| <a name="output_azure_devops_organization_url"></a> [azure\_devops\_organization\_url](#output\_azure\_devops\_organization\_url) | Azure DevOps organization URL |
99+
| <a name="output_key_vault_id"></a> [key\_vault\_id](#output\_key\_vault\_id) | ID of the Key Vault for storing Azure DevOps PAT |
100+
| <a name="output_key_vault_name"></a> [key\_vault\_name](#output\_key\_vault\_name) | Name of the Key Vault for storing Azure DevOps PAT |
101+
| <a name="output_key_vault_uri"></a> [key\_vault\_uri](#output\_key\_vault\_uri) | URI of the Key Vault for storing Azure DevOps PAT |
102+
| <a name="output_resource_group_name"></a> [resource\_group\_name](#output\_resource\_group\_name) | Name of the resource group containing the Key Vault |
103+
| <a name="output_service_principal_client_id"></a> [service\_principal\_client\_id](#output\_service\_principal\_client\_id) | Client ID of the Azure DevOps service principal |
104+
| <a name="output_service_principal_object_id"></a> [service\_principal\_object\_id](#output\_service\_principal\_object\_id) | Object ID of the Azure DevOps service principal |
105+
<!-- END_TF_DOCS -->

‎modules/azuredevops/pipeline/buildingblock/APP_TEAM_README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ trigger:
361361
362362
**Cause**: Variable group ID doesn't exist or no permissions
363363
364-
**Solution**:
364+
**Solution**:
365365
1. Verify variable group exists in project
366366
2. Check variable group ID is correct
367367
3. Ensure permissions to link variable groups

‎modules/azuredevops/pipeline/buildingblock/README.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,3 +185,53 @@ steps:
185185
- Pipeline definition must be YAML-based (classic pipelines not supported)
186186
- YAML file must exist in the repository before pipeline creation
187187
- Repository must be accessible with the provided credentials
188+
189+
<!-- BEGIN_TF_DOCS -->
190+
## Requirements
191+
192+
| Name | Version |
193+
|------|---------|
194+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
195+
| <a name="requirement_azuredevops"></a> [azuredevops](#requirement\_azuredevops) | ~> 1.1.1 |
196+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~> 3.116.0 |
197+
198+
## Modules
199+
200+
No modules.
201+
202+
## Resources
203+
204+
| Name | Type |
205+
|------|------|
206+
| [azuredevops_build_definition.main](https://registry.terraform.io/providers/microsoft/azuredevops/latest/docs/resources/build_definition) | resource |
207+
| [azurerm_key_vault.devops](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/key_vault) | data source |
208+
| [azurerm_key_vault_secret.azure_devops_pat](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/key_vault_secret) | data source |
209+
210+
## Inputs
211+
212+
| Name | Description | Type | Default | Required |
213+
|------|-------------|------|---------|:--------:|
214+
| <a name="input_azure_devops_organization_url"></a> [azure\_devops\_organization\_url](#input\_azure\_devops\_organization\_url) | Azure DevOps organization URL (e.g., https://dev.azure.com/myorg) | `string` | n/a | yes |
215+
| <a name="input_branch_name"></a> [branch\_name](#input\_branch\_name) | Default branch for the pipeline | `string` | `"refs/heads/main"` | no |
216+
| <a name="input_key_vault_name"></a> [key\_vault\_name](#input\_key\_vault\_name) | Name of the Key Vault containing the Azure DevOps PAT | `string` | n/a | yes |
217+
| <a name="input_pat_secret_name"></a> [pat\_secret\_name](#input\_pat\_secret\_name) | Name of the secret in Key Vault that contains the Azure DevOps PAT | `string` | `"azdo-pat"` | no |
218+
| <a name="input_pipeline_name"></a> [pipeline\_name](#input\_pipeline\_name) | Name of the pipeline to create | `string` | n/a | yes |
219+
| <a name="input_pipeline_variables"></a> [pipeline\_variables](#input\_pipeline\_variables) | List of pipeline variables to create | <pre>list(object({<br> name = string<br> value = string<br> is_secret = optional(bool, false)<br> allow_override = optional(bool, true)<br> }))</pre> | `[]` | no |
220+
| <a name="input_project_id"></a> [project\_id](#input\_project\_id) | Azure DevOps Project ID where the pipeline will be created | `string` | n/a | yes |
221+
| <a name="input_repository_id"></a> [repository\_id](#input\_repository\_id) | Repository ID or name where the pipeline YAML file is located | `string` | n/a | yes |
222+
| <a name="input_repository_type"></a> [repository\_type](#input\_repository\_type) | Type of repository. Options: TfsGit, GitHub, GitHubEnterprise, Bitbucket | `string` | `"TfsGit"` | no |
223+
| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | Name of the resource group containing the Key Vault | `string` | n/a | yes |
224+
| <a name="input_variable_group_ids"></a> [variable\_group\_ids](#input\_variable\_group\_ids) | List of variable group IDs to link to this pipeline | `list(number)` | `[]` | no |
225+
| <a name="input_yaml_path"></a> [yaml\_path](#input\_yaml\_path) | Path to the YAML pipeline definition file in the repository | `string` | `"azure-pipelines.yml"` | no |
226+
227+
## Outputs
228+
229+
| Name | Description |
230+
|------|-------------|
231+
| <a name="output_pipeline_id"></a> [pipeline\_id](#output\_pipeline\_id) | ID of the created pipeline |
232+
| <a name="output_pipeline_name"></a> [pipeline\_name](#output\_pipeline\_name) | Name of the created pipeline |
233+
| <a name="output_pipeline_revision"></a> [pipeline\_revision](#output\_pipeline\_revision) | Revision number of the pipeline |
234+
| <a name="output_project_id"></a> [project\_id](#output\_project\_id) | Project ID where the pipeline was created |
235+
| <a name="output_repository_id"></a> [repository\_id](#output\_repository\_id) | Repository ID linked to the pipeline |
236+
| <a name="output_yaml_path"></a> [yaml\_path](#output\_yaml\_path) | Path to the YAML pipeline definition |
237+
<!-- END_TF_DOCS -->

‎modules/azuredevops/pipeline/buildingblock/main.tf‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ resource "azuredevops_build_definition" "main" {
2828
dynamic "variable" {
2929
for_each = var.pipeline_variables
3030
content {
31-
name = variable.value.name
32-
value = variable.value.value
33-
is_secret = lookup(variable.value, "is_secret", false)
31+
name = variable.value.name
32+
value = variable.value.value
33+
is_secret = lookup(variable.value, "is_secret", false)
3434
allow_override = lookup(variable.value, "allow_override", true)
3535
}
3636
}

‎modules/azuredevops/project/backplane/README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,6 @@ No modules.
8383
| [azuread_service_principal.azure_devops](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/service_principal) | resource |
8484
| [azurerm_key_vault.devops](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault) | resource |
8585
| [azurerm_resource_group.devops](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
86-
| [azurerm_resource_group_template_deployment.documentation](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group_template_deployment) | resource |
8786
| [azurerm_role_assignment.azure_devops_manager](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment) | resource |
8887
| [azurerm_role_definition.azure_devops_manager](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_definition) | resource |
8988
| [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) | data source |

‎modules/azuredevops/repository/backplane/README.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,53 @@ module "azuredevops_repository_backplane" {
5353
- Service principal has read-only access to Key Vault secrets
5454
- PAT should be rotated regularly (recommended: every 90 days)
5555
- Use separate backplane instances for different environments
56+
57+
<!-- BEGIN_TF_DOCS -->
58+
## Requirements
59+
60+
| Name | Version |
61+
|------|---------|
62+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
63+
| <a name="requirement_azuread"></a> [azuread](#requirement\_azuread) | ~> 2.53.1 |
64+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~> 3.116.0 |
65+
66+
## Modules
67+
68+
No modules.
69+
70+
## Resources
71+
72+
| Name | Type |
73+
|------|------|
74+
| [azuread_application.azure_devops](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/application) | resource |
75+
| [azuread_service_principal.azure_devops](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/service_principal) | resource |
76+
| [azurerm_key_vault.devops](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault) | resource |
77+
| [azurerm_resource_group.devops](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
78+
| [azurerm_role_assignment.azure_devops_manager](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment) | resource |
79+
| [azurerm_role_definition.azure_devops_manager](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_definition) | resource |
80+
| [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) | data source |
81+
| [azurerm_subscription.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/subscription) | data source |
82+
83+
## Inputs
84+
85+
| Name | Description | Type | Default | Required |
86+
|------|-------------|------|---------|:--------:|
87+
| <a name="input_azure_devops_organization_url"></a> [azure\_devops\_organization\_url](#input\_azure\_devops\_organization\_url) | Azure DevOps organization URL (e.g., https://dev.azure.com/myorg) | `string` | n/a | yes |
88+
| <a name="input_key_vault_name"></a> [key\_vault\_name](#input\_key\_vault\_name) | Name of the Key Vault to store the Azure DevOps PAT | `string` | n/a | yes |
89+
| <a name="input_location"></a> [location](#input\_location) | Azure region for resources | `string` | `"West Europe"` | no |
90+
| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | Resource group name for the Key Vault | `string` | n/a | yes |
91+
| <a name="input_scope"></a> [scope](#input\_scope) | Azure scope for role definitions (subscription or management group) | `string` | n/a | yes |
92+
| <a name="input_service_principal_name"></a> [service\_principal\_name](#input\_service\_principal\_name) | Name for the Azure DevOps service principal | `string` | `"azure-devops-terraform"` | no |
93+
94+
## Outputs
95+
96+
| Name | Description |
97+
|------|-------------|
98+
| <a name="output_azure_devops_organization_url"></a> [azure\_devops\_organization\_url](#output\_azure\_devops\_organization\_url) | Azure DevOps organization URL |
99+
| <a name="output_key_vault_id"></a> [key\_vault\_id](#output\_key\_vault\_id) | ID of the Key Vault for storing Azure DevOps PAT |
100+
| <a name="output_key_vault_name"></a> [key\_vault\_name](#output\_key\_vault\_name) | Name of the Key Vault for storing Azure DevOps PAT |
101+
| <a name="output_key_vault_uri"></a> [key\_vault\_uri](#output\_key\_vault\_uri) | URI of the Key Vault for storing Azure DevOps PAT |
102+
| <a name="output_resource_group_name"></a> [resource\_group\_name](#output\_resource\_group\_name) | Name of the resource group containing the Key Vault |
103+
| <a name="output_service_principal_client_id"></a> [service\_principal\_client\_id](#output\_service\_principal\_client\_id) | Client ID of the Azure DevOps service principal |
104+
| <a name="output_service_principal_object_id"></a> [service\_principal\_object\_id](#output\_service\_principal\_object\_id) | Object ID of the Azure DevOps service principal |
105+
<!-- END_TF_DOCS -->

‎modules/azuredevops/repository/buildingblock/README.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,3 +93,53 @@ module "app_repository" {
9393
- Minimum reviewers prevent unreviewed code from being merged
9494
- Work item linking ensures traceability
9595
- PAT should have minimal required scopes (`Code (Read & Write)`)
96+
97+
<!-- BEGIN_TF_DOCS -->
98+
## Requirements
99+
100+
| Name | Version |
101+
|------|---------|
102+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
103+
| <a name="requirement_azuredevops"></a> [azuredevops](#requirement\_azuredevops) | ~> 1.1.1 |
104+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~> 3.116.0 |
105+
106+
## Modules
107+
108+
No modules.
109+
110+
## Resources
111+
112+
| Name | Type |
113+
|------|------|
114+
| [azuredevops_branch_policy_min_reviewers.main](https://registry.terraform.io/providers/microsoft/azuredevops/latest/docs/resources/branch_policy_min_reviewers) | resource |
115+
| [azuredevops_branch_policy_work_item_linking.main](https://registry.terraform.io/providers/microsoft/azuredevops/latest/docs/resources/branch_policy_work_item_linking) | resource |
116+
| [azuredevops_git_repository.main](https://registry.terraform.io/providers/microsoft/azuredevops/latest/docs/resources/git_repository) | resource |
117+
| [azurerm_key_vault.devops](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/key_vault) | data source |
118+
| [azurerm_key_vault_secret.azure_devops_pat](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/key_vault_secret) | data source |
119+
120+
## Inputs
121+
122+
| Name | Description | Type | Default | Required |
123+
|------|-------------|------|---------|:--------:|
124+
| <a name="input_azure_devops_organization_url"></a> [azure\_devops\_organization\_url](#input\_azure\_devops\_organization\_url) | Azure DevOps organization URL (e.g., https://dev.azure.com/myorg) | `string` | n/a | yes |
125+
| <a name="input_enable_branch_policies"></a> [enable\_branch\_policies](#input\_enable\_branch\_policies) | Enable branch protection policies on the default branch | `bool` | `true` | no |
126+
| <a name="input_init_type"></a> [init\_type](#input\_init\_type) | Type of repository initialization. Options: Clean, Import, Uninitialized | `string` | `"Clean"` | no |
127+
| <a name="input_key_vault_name"></a> [key\_vault\_name](#input\_key\_vault\_name) | Name of the Key Vault containing the Azure DevOps PAT | `string` | n/a | yes |
128+
| <a name="input_minimum_reviewers"></a> [minimum\_reviewers](#input\_minimum\_reviewers) | Minimum number of reviewers required for pull requests | `number` | `2` | no |
129+
| <a name="input_pat_secret_name"></a> [pat\_secret\_name](#input\_pat\_secret\_name) | Name of the secret in Key Vault that contains the Azure DevOps PAT | `string` | `"azdo-pat"` | no |
130+
| <a name="input_project_id"></a> [project\_id](#input\_project\_id) | Azure DevOps Project ID where the repository will be created | `string` | n/a | yes |
131+
| <a name="input_repository_name"></a> [repository\_name](#input\_repository\_name) | Name of the Git repository to create | `string` | n/a | yes |
132+
| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | Name of the resource group containing the Key Vault | `string` | n/a | yes |
133+
134+
## Outputs
135+
136+
| Name | Description |
137+
|------|-------------|
138+
| <a name="output_branch_policies_enabled"></a> [branch\_policies\_enabled](#output\_branch\_policies\_enabled) | Whether branch policies are enabled |
139+
| <a name="output_default_branch"></a> [default\_branch](#output\_default\_branch) | Default branch of the repository |
140+
| <a name="output_repository_id"></a> [repository\_id](#output\_repository\_id) | ID of the created repository |
141+
| <a name="output_repository_name"></a> [repository\_name](#output\_repository\_name) | Name of the created repository |
142+
| <a name="output_repository_url"></a> [repository\_url](#output\_repository\_url) | URL of the created repository |
143+
| <a name="output_ssh_url"></a> [ssh\_url](#output\_ssh\_url) | SSH URL of the repository |
144+
| <a name="output_web_url"></a> [web\_url](#output\_web\_url) | Web URL of the repository |
145+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)