Skip to content

Commit 1547b8e

Browse files
eriquaeriqua
authored
ci: List imported remote references as cross referenced modules in readme (#3650)
## Description Closes #3649 ## Pipeline Reference <!-- Insert your Pipeline Status Badge below --> | Pipeline | | -------- | | [![avm.res.storage.storage-account](https://github.com/eriqua/bicep-registry-modules/actions/workflows/avm.res.storage.storage-account.yml/badge.svg?branch=cross-reference-import&event=workflow_dispatch)](https://github.com/eriqua/bicep-registry-modules/actions/workflows/avm.res.storage.storage-account.yml) [![avm.res.automation.automation-account](https://github.com/eriqua/bicep-registry-modules/actions/workflows/avm.res.automation.automation-account.yml/badge.svg?branch=cross-reference-import&event=workflow_dispatch)](https://github.com/eriqua/bicep-registry-modules/actions/workflows/avm.res.automation.automation-account.yml) [![avm.res.service-bus.namespace](https://github.com/eriqua/bicep-registry-modules/actions/workflows/avm.res.service-bus.namespace.yml/badge.svg?branch=cross-reference-import&event=workflow_dispatch)](https://github.com/eriqua/bicep-registry-modules/actions/workflows/avm.res.service-bus.namespace.yml) | ## Type of Change <!-- Use the checkboxes [x] on the options that are relevant. --> - [x] Update to CI Environment or utilities (Non-module affecting changes) - [ ] Azure Verified Module updates: - [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT bumped the MAJOR or MINOR version in `version.json`: - [ ] Someone has opened a bug report issue, and I have included "Closes #{bug_report_issue_number}" in the PR description. - [ ] The bug was found by the module author, and no one has opened an issue to report it yet. - [ ] Feature update backwards compatible feature updates, and I have bumped the MINOR version in `version.json`. - [ ] Breaking changes and I have bumped the MAJOR version in `version.json`. - [ ] Update to documentation ## Checklist - [x] I'm sure there are no other open Pull Requests for the same update/change - [x] I have run `Set-AVMModule` locally to generate the supporting module files. - [x] My corresponding pipelines / checks run clean and green without any errors or warnings <!-- Please keep up to date with the contribution guide at https://aka.ms/avm/contribute/bicep -->
1 parent 9d38583 commit 1547b8e

File tree

21 files changed

+133
-1
lines changed

21 files changed

+133
-1
lines changed

‎avm/ptn/network/private-link-private-dns-zones/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,7 @@ This section gives you an overview of all local-referenced module files (i.e., o
439439
| Reference | Type |
440440
| :-- | :-- |
441441
| `br/public:avm/res/network/private-dns-zone:0.6.0` | Remote reference |
442+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |
442443

443444
## Data Collection
444445

‎avm/res/automation/automation-account/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -2651,6 +2651,7 @@ This section gives you an overview of all local-referenced module files (i.e., o
26512651
| :-- | :-- |
26522652
| `br/public:avm/res/network/private-endpoint:0.7.1` | Remote reference |
26532653
| `br/public:avm/res/operations-management/solution:0.1.3` | Remote reference |
2654+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |
26542655

26552656
## Data Collection
26562657

‎avm/res/db-for-postgre-sql/flexible-server/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -2390,6 +2390,7 @@ This section gives you an overview of all local-referenced module files (i.e., o
23902390
| Reference | Type |
23912391
| :-- | :-- |
23922392
| `br/public:avm/res/network/private-endpoint:0.8.0` | Remote reference |
2393+
| `br/public:avm/utl/types/avm-common-types:0.1.0` | Remote reference |
23932394

23942395
## Data Collection
23952396

‎avm/res/fabric/capacity/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This module deploys Fabric capacities, which provide the compute resources for a
88
- [Usage examples](#Usage-examples)
99
- [Parameters](#Parameters)
1010
- [Outputs](#Outputs)
11+
- [Cross-referenced modules](#Cross-referenced-modules)
1112
- [Data Collection](#Data-Collection)
1213

1314
## Resource Types
@@ -413,6 +414,14 @@ Tags of the resource.
413414
| `resourceGroupName` | string | The name of the resource group the module was deployed to. |
414415
| `resourceId` | string | The resource ID of the deployed Fabric resource. |
415416

417+
## Cross-referenced modules
418+
419+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
420+
421+
| Reference | Type |
422+
| :-- | :-- |
423+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |
424+
416425
## Data Collection
417426

418427
The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the [repository](https://aka.ms/avm/telemetry). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at <https://go.microsoft.com/fwlink/?LinkID=824704>. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

‎avm/res/network/private-endpoint/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This module deploys a Private Endpoint.
88
- [Usage examples](#Usage-examples)
99
- [Parameters](#Parameters)
1010
- [Outputs](#Outputs)
11+
- [Cross-referenced modules](#Cross-referenced-modules)
1112
- [Data Collection](#Data-Collection)
1213

1314
## Resource Types
@@ -1278,6 +1279,14 @@ Tags to be applied on all resources/resource groups in this deployment.
12781279
| `resourceGroupName` | string | The resource group the private endpoint was deployed into. |
12791280
| `resourceId` | string | The resource ID of the private endpoint. |
12801281

1282+
## Cross-referenced modules
1283+
1284+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
1285+
1286+
| Reference | Type |
1287+
| :-- | :-- |
1288+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |
1289+
12811290
## Data Collection
12821291

12831292
The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the [repository](https://aka.ms/avm/telemetry). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at <https://go.microsoft.com/fwlink/?LinkID=824704>. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

‎avm/res/network/virtual-network/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This module deploys a Virtual Network (vNet).
1313
- [Usage examples](#Usage-examples)
1414
- [Parameters](#Parameters)
1515
- [Outputs](#Outputs)
16+
- [Cross-referenced modules](#Cross-referenced-modules)
1617
- [Notes](#Notes)
1718
- [Data Collection](#Data-Collection)
1819

@@ -1924,6 +1925,14 @@ If the encrypted VNet allows VM that does not support encryption. Can only be us
19241925
| `subnetNames` | array | The names of the deployed subnets. |
19251926
| `subnetResourceIds` | array | The resource IDs of the deployed subnets. |
19261927

1928+
## Cross-referenced modules
1929+
1930+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
1931+
1932+
| Reference | Type |
1933+
| :-- | :-- |
1934+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |
1935+
19271936
## Notes
19281937

19291938
### Considerations

‎avm/res/purview/account/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -3452,6 +3452,7 @@ This section gives you an overview of all local-referenced module files (i.e., o
34523452
| Reference | Type |
34533453
| :-- | :-- |
34543454
| `br/public:avm/res/network/private-endpoint:0.7.1` | Remote reference |
3455+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |
34553456

34563457
## Data Collection
34573458

‎avm/res/service-bus/namespace/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -3517,6 +3517,7 @@ This section gives you an overview of all local-referenced module files (i.e., o
35173517
| Reference | Type |
35183518
| :-- | :-- |
35193519
| `br/public:avm/res/network/private-endpoint:0.7.1` | Remote reference |
3520+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |
35203521

35213522
## Data Collection
35223523

‎avm/res/service-bus/namespace/queue/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This module deploys a Service Bus Namespace Queue.
77
- [Resource Types](#Resource-Types)
88
- [Parameters](#Parameters)
99
- [Outputs](#Outputs)
10+
- [Cross-referenced modules](#Cross-referenced-modules)
1011

1112
## Resource Types
1213

@@ -365,3 +366,11 @@ Enumerates the possible values for the status of a messaging entity. - Active, D
365366
| `name` | string | The name of the deployed queue. |
366367
| `resourceGroupName` | string | The resource group of the deployed queue. |
367368
| `resourceId` | string | The resource ID of the deployed queue. |
369+
370+
## Cross-referenced modules
371+
372+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
373+
374+
| Reference | Type |
375+
| :-- | :-- |
376+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |

‎avm/res/service-bus/namespace/topic/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This module deploys a Service Bus Namespace Topic.
77
- [Resource Types](#Resource-Types)
88
- [Parameters](#Parameters)
99
- [Outputs](#Outputs)
10+
- [Cross-referenced modules](#Cross-referenced-modules)
1011

1112
## Resource Types
1213

@@ -509,3 +510,11 @@ Value that indicates whether the topic supports ordering.
509510
| `name` | string | The name of the deployed topic. |
510511
| `resourceGroupName` | string | The resource group of the deployed topic. |
511512
| `resourceId` | string | The resource ID of the deployed topic. |
513+
514+
## Cross-referenced modules
515+
516+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
517+
518+
| Reference | Type |
519+
| :-- | :-- |
520+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |

‎avm/res/storage/storage-account/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -4484,6 +4484,7 @@ This section gives you an overview of all local-referenced module files (i.e., o
44844484
| Reference | Type |
44854485
| :-- | :-- |
44864486
| `br/public:avm/res/network/private-endpoint:0.7.1` | Remote reference |
4487+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |
44874488

44884489
## Notes
44894490

‎avm/res/storage/storage-account/blob-service/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This module deploys a Storage Account Blob Service.
77
- [Resource Types](#Resource-Types)
88
- [Parameters](#Parameters)
99
- [Outputs](#Outputs)
10+
- [Cross-referenced modules](#Cross-referenced-modules)
1011

1112
## Resource Types
1213

@@ -333,3 +334,11 @@ The blob service properties for blob restore policy. If point-in-time restore is
333334
| `name` | string | The name of the deployed blob service. |
334335
| `resourceGroupName` | string | The name of the deployed blob service. |
335336
| `resourceId` | string | The resource ID of the deployed blob service. |
337+
338+
## Cross-referenced modules
339+
340+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
341+
342+
| Reference | Type |
343+
| :-- | :-- |
344+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |

‎avm/res/storage/storage-account/blob-service/container/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This module deploys a Storage Account Blob Container.
77
- [Resource Types](#Resource-Types)
88
- [Parameters](#Parameters)
99
- [Outputs](#Outputs)
10+
- [Cross-referenced modules](#Cross-referenced-modules)
1011

1112
## Resource Types
1213

@@ -265,3 +266,11 @@ The principal type of the assigned principal ID.
265266
| `name` | string | The name of the deployed container. |
266267
| `resourceGroupName` | string | The resource group of the deployed container. |
267268
| `resourceId` | string | The resource ID of the deployed container. |
269+
270+
## Cross-referenced modules
271+
272+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
273+
274+
| Reference | Type |
275+
| :-- | :-- |
276+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |

‎avm/res/storage/storage-account/file-service/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This module deploys a Storage Account File Share Service.
77
- [Resource Types](#Resource-Types)
88
- [Parameters](#Parameters)
99
- [Outputs](#Outputs)
10+
- [Cross-referenced modules](#Cross-referenced-modules)
1011

1112
## Resource Types
1213

@@ -231,3 +232,11 @@ File shares to create.
231232
| `name` | string | The name of the deployed file share service. |
232233
| `resourceGroupName` | string | The resource group of the deployed file share service. |
233234
| `resourceId` | string | The resource ID of the deployed file share service. |
235+
236+
## Cross-referenced modules
237+
238+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
239+
240+
| Reference | Type |
241+
| :-- | :-- |
242+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |

‎avm/res/storage/storage-account/file-service/share/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This module deploys a Storage Account File Share.
77
- [Resource Types](#Resource-Types)
88
- [Parameters](#Parameters)
99
- [Outputs](#Outputs)
10+
- [Cross-referenced modules](#Cross-referenced-modules)
1011

1112
## Resource Types
1213

@@ -221,3 +222,11 @@ The maximum size of the share, in gigabytes. Must be greater than 0, and less th
221222
| `name` | string | The name of the deployed file share. |
222223
| `resourceGroupName` | string | The resource group of the deployed file share. |
223224
| `resourceId` | string | The resource ID of the deployed file share. |
225+
226+
## Cross-referenced modules
227+
228+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
229+
230+
| Reference | Type |
231+
| :-- | :-- |
232+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |

‎avm/res/storage/storage-account/queue-service/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This module deploys a Storage Account Queue Service.
77
- [Resource Types](#Resource-Types)
88
- [Parameters](#Parameters)
99
- [Outputs](#Outputs)
10+
- [Cross-referenced modules](#Cross-referenced-modules)
1011

1112
## Resource Types
1213

@@ -199,3 +200,11 @@ Queues to create.
199200
| `name` | string | The name of the deployed file share service. |
200201
| `resourceGroupName` | string | The resource group of the deployed file share service. |
201202
| `resourceId` | string | The resource ID of the deployed file share service. |
203+
204+
## Cross-referenced modules
205+
206+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
207+
208+
| Reference | Type |
209+
| :-- | :-- |
210+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |

‎avm/res/storage/storage-account/queue-service/queue/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This module deploys a Storage Account Queue.
77
- [Resource Types](#Resource-Types)
88
- [Parameters](#Parameters)
99
- [Outputs](#Outputs)
10+
- [Cross-referenced modules](#Cross-referenced-modules)
1011

1112
## Resource Types
1213

@@ -176,3 +177,11 @@ The principal type of the assigned principal ID.
176177
| `name` | string | The name of the deployed queue. |
177178
| `resourceGroupName` | string | The resource group of the deployed queue. |
178179
| `resourceId` | string | The resource ID of the deployed queue. |
180+
181+
## Cross-referenced modules
182+
183+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
184+
185+
| Reference | Type |
186+
| :-- | :-- |
187+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |

‎avm/res/storage/storage-account/table-service/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This module deploys a Storage Account Table Service.
77
- [Resource Types](#Resource-Types)
88
- [Parameters](#Parameters)
99
- [Outputs](#Outputs)
10+
- [Cross-referenced modules](#Cross-referenced-modules)
1011

1112
## Resource Types
1213

@@ -200,3 +201,11 @@ tables to create.
200201
| `name` | string | The name of the deployed table service. |
201202
| `resourceGroupName` | string | The resource group of the deployed table service. |
202203
| `resourceId` | string | The resource ID of the deployed table service. |
204+
205+
## Cross-referenced modules
206+
207+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
208+
209+
| Reference | Type |
210+
| :-- | :-- |
211+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |

‎avm/res/storage/storage-account/table-service/table/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This module deploys a Storage Account Table.
77
- [Resource Types](#Resource-Types)
88
- [Parameters](#Parameters)
99
- [Outputs](#Outputs)
10+
- [Cross-referenced modules](#Cross-referenced-modules)
1011

1112
## Resource Types
1213

@@ -165,3 +166,11 @@ The principal type of the assigned principal ID.
165166
| `name` | string | The name of the deployed file share service. |
166167
| `resourceGroupName` | string | The resource group of the deployed file share service. |
167168
| `resourceId` | string | The resource ID of the deployed file share service. |
169+
170+
## Cross-referenced modules
171+
172+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
173+
174+
| Reference | Type |
175+
| :-- | :-- |
176+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |

‎avm/res/virtual-machine-images/image-template/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This module deploys a Virtual Machine Image Template that can be consumed by Azu
88
- [Usage examples](#Usage-examples)
99
- [Parameters](#Parameters)
1010
- [Outputs](#Outputs)
11+
- [Cross-referenced modules](#Cross-referenced-modules)
1112
- [Notes](#Notes)
1213
- [Data Collection](#Data-Collection)
1314

@@ -1174,6 +1175,14 @@ Do not provide a value! This date is used to generate a unique image template na
11741175
| `resourceId` | string | The resource ID of the image template. |
11751176
| `runThisCommand` | string | The command to run in order to trigger the image build. |
11761177

1178+
## Cross-referenced modules
1179+
1180+
This section gives you an overview of all local-referenced module files (i.e., other modules that are referenced in this module) and all remote-referenced files (i.e., Bicep modules that are referenced from a Bicep Registry or Template Specs).
1181+
1182+
| Reference | Type |
1183+
| :-- | :-- |
1184+
| `br/public:avm/utl/types/avm-common-types:0.2.1` | Remote reference |
1185+
11771186
## Notes
11781187

11791188
### Parameter Usage: `imageSource`

‎avm/utilities/pipelines/sharedScripts/helper/Get-CrossReferencedModuleList.ps1

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ function Get-ReferenceObject {
9292
$moduleContent = $TemplateMap[$involvedFilePath]
9393

9494
$resultSet.resourceReferences += @() + $moduleContent | Where-Object { $_ -match "^resource .+ '(.+?)' .+$" } | ForEach-Object { $matches[1] }
95-
$resultSet.remoteReferences += @() + $moduleContent | Where-Object { $_ -match "^module .+ '(.+:.+?)' .+$" } | ForEach-Object { $matches[1] }
95+
$resultSet.remoteReferences += @() + $moduleContent | Where-Object { $_ -match "^module .+ '(.+:.+?)' .+$" -or $_ -match "^import .+ '(.+:.+?)'$" } | ForEach-Object { $matches[1] }
9696
}
9797

9898
return @{

0 commit comments

Comments
 (0)