Skip to content

Commit

Permalink
fix: Remove outdated metadata from bicep tests & readme's (#845)
Browse files Browse the repository at this point in the history
## Description

Remove outdated metadata from bicep tests & readme's.
Background: The original PSRule issue that required us to implement
optional parameters was fixed some time ago and the disclaimer was just
not removed yet.

| Pipeline |
| - |

[![avm.res.compute.ssh-public-key](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.compute.ssh-public-key.yml/badge.svg?branch=users%2Falsehr%2FtestCleanup&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.compute.ssh-public-key.yml)

[![avm.res.key-vault.vault](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.key-vault.vault.yml/badge.svg?branch=users%2Falsehr%2FtestCleanup&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.key-vault.vault.yml)

[![avm.res.kubernetes-configuration.extension](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.kubernetes-configuration.extension.yml/badge.svg?branch=users%2Falsehr%2FtestCleanup&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.kubernetes-configuration.extension.yml)

[![avm.res.kubernetes-configuration.flux-configuration](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.kubernetes-configuration.flux-configuration.yml/badge.svg?branch=users%2Falsehr%2FtestCleanup&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.kubernetes-configuration.flux-configuration.yml)

[![avm.res.logic.workflow](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.logic.workflow.yml/badge.svg?branch=users%2Falsehr%2FtestCleanup&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.logic.workflow.yml)

[![avm.res.network.dns-forwarding-ruleset](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.dns-forwarding-ruleset.yml/badge.svg?branch=users%2Falsehr%2FtestCleanup&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.dns-forwarding-ruleset.yml)

[![avm.res.network.dns-resolver](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.dns-resolver.yml/badge.svg?branch=users%2Falsehr%2FtestCleanup&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.dns-resolver.yml)

[![avm.res.network.private-dns-zone](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.private-dns-zone.yml/badge.svg?branch=users%2Falsehr%2FtestCleanup&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.private-dns-zone.yml)

[![avm.res.network.private-endpoint](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.private-endpoint.yml/badge.svg?branch=users%2Falsehr%2FtestCleanup&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.private-endpoint.yml)

[![avm.res.network.public-ip-address](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.public-ip-address.yml/badge.svg?branch=users%2Falsehr%2FtestCleanup&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.public-ip-address.yml)

[![avm.res.resources.deployment-script](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.resources.deployment-script.yml/badge.svg?branch=users%2Falsehr%2FtestCleanup&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.resources.deployment-script.yml)

---------

Co-authored-by: Erika Gressi <[email protected]>
  • Loading branch information
AlexanderSehr and eriqua authored Jan 31, 2024
1 parent 10aa23e commit 9acbd4f
Show file tree
Hide file tree
Showing 22 changed files with 11 additions and 66 deletions.
2 changes: 0 additions & 2 deletions avm/res/compute/ssh-public-key/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ The following section provides usage examples for the module, which were used to
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.


<details>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = '''
This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.
'''
metadata description = 'This instance deploys the module with the minimum set of required parameters.'
// ========== //
// Parameters //
// ========== //
Expand Down
2 changes: 0 additions & 2 deletions avm/res/key-vault/vault/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ The following section provides usage examples for the module, which were used to
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.


<details>
Expand Down
5 changes: 1 addition & 4 deletions avm/res/key-vault/vault/tests/e2e/defaults/main.test.bicep
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = '''
This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.
'''
metadata description = 'This instance deploys the module with the minimum set of required parameters.'

// ========== //
// Parameters //
Expand Down
2 changes: 0 additions & 2 deletions avm/res/kubernetes-configuration/extension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ The following section provides usage examples for the module, which were used to
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.


<details>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = '''
This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.
'''
metadata description = 'This instance deploys the module with the minimum set of required parameters.'
// ========== //
// Parameters //
// ========== //
Expand Down
2 changes: 0 additions & 2 deletions avm/res/kubernetes-configuration/flux-configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ The following section provides usage examples for the module, which were used to
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.


<details>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = '''
This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.
'''
metadata description = 'This instance deploys the module with the minimum set of required parameters.'

// ========== //
// Parameters //
Expand Down
2 changes: 0 additions & 2 deletions avm/res/logic/workflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ The following section provides usage examples for the module, which were used to
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.


<details>
Expand Down
5 changes: 1 addition & 4 deletions avm/res/logic/workflow/tests/e2e/defaults/main.test.bicep
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = '''
This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.
'''
metadata description = 'This instance deploys the module with the minimum set of required parameters.'

// ========== //
// Parameters //
Expand Down
2 changes: 0 additions & 2 deletions avm/res/network/dns-forwarding-ruleset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ The following section provides usage examples for the module, which were used to
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.


<details>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = '''
This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.
'''
metadata description = 'This instance deploys the module with the minimum set of required parameters.'

// ========== //
// Parameters //
Expand Down
2 changes: 0 additions & 2 deletions avm/res/network/dns-resolver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ The following section provides usage examples for the module, which were used to
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.


<details>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = '''
This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.
'''
metadata description = 'This instance deploys the module with the minimum set of required parameters.'

// ========== //
// Parameters //
Expand Down
2 changes: 0 additions & 2 deletions avm/res/network/private-dns-zone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ The following section provides usage examples for the module, which were used to
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.


<details>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = '''
This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.
'''
metadata description = 'This instance deploys the module with the minimum set of required parameters.'

// ========== //
// Parameters //
Expand Down
2 changes: 0 additions & 2 deletions avm/res/network/private-endpoint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ The following section provides usage examples for the module, which were used to
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.


<details>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = '''
This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.
'''
metadata description = 'This instance deploys the module with the minimum set of required parameters.'

// ========== //
// Parameters //
Expand Down
2 changes: 0 additions & 2 deletions avm/res/network/public-ip-address/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ The following section provides usage examples for the module, which were used to
### Example 1: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.


<details>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = '''
This instance deploys the module with the minimum set of required parameters.
> **Note:** The test currently implements additional non-required parameters to cater for a test-specific limitation.
'''
metadata description = 'This instance deploys the module with the minimum set of required parameters.'

// ========== //
// Parameters //
Expand Down
2 changes: 0 additions & 2 deletions avm/res/resources/deployment-script/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,6 @@ module deploymentScript 'br/public:avm/res/resources/deployment-script:<version>
### Example 2: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.
> **Note:** In this scenario, In this scenario, the `Storage File Data Privileged Contributor` role needs to be assigned to the user-assigned managed identity and the deployment principal needs to have permissions to list the storage account keys.


<details>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = '''
This instance deploys the module with the minimum set of required parameters.
> **Note:** In this scenario, In this scenario, the `Storage File Data Privileged Contributor` role needs to be assigned to the user-assigned managed identity and the deployment principal needs to have permissions to list the storage account keys.
'''
metadata description = 'This instance deploys the module with the minimum set of required parameters.'

// ========== //
// Parameters //
Expand Down

0 comments on commit 9acbd4f

Please sign in to comment.