forked from Azure/bicep-registry-modules
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: New utility module - AVM Common Types (Azure#3397)
## Description - Implemented AVM common types module which can be used to reduce duplicated code in the code base - Reduced the tests in `main.test.bicep` for UDTs as they are not compatible with using a module reference - Added a quotation-escape to the deployment action as it turned out that it breaks if you have single quotes in your deployment output Example implementation in KeyVault module: > **Note:** The type should always be implemented by name as a `*` implementation causes all types to be added to the combiled `main.json`   ## Pipeline Reference <!-- Insert your Pipeline Status Badge below --> | Pipeline | | -------- | | [](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.utl.types.avm-common-type.yml) | | [](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.key-vault.vault.yml) [run using local ref](https://github.com/AlexanderSehr/bicep-registry-modules/actions/runs/11164377047) | ## Type of Change <!-- Use the checkboxes [x] on the options that are relevant. --> - [ ] Update to CI Environment or utilities (Non-module affecting changes) - [x] 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
](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.utl.types.avm-common-type.yml){kind=link}
](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.key-vault.vault.yml){kind=link}
- Loading branch information
1 parent
6fd1411
commit da7e5cb
Showing
10 changed files
with
2,053 additions
and
73 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| name: "avm.utl.types.avm-common-types" | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| staticValidation: | ||
| type: boolean | ||
| description: "Execute static validation" | ||
| required: false | ||
| default: false # true | ||
| deploymentValidation: | ||
| type: boolean | ||
| description: "Execute deployment validation" | ||
| required: false | ||
| default: true | ||
| removeDeployment: | ||
| type: boolean | ||
| description: "Remove deployed module" | ||
| required: false | ||
| default: true | ||
| customLocation: | ||
| type: string | ||
| description: "Default location overwrite (e.g., eastus)" | ||
| required: false | ||
| default: 'northeurope' | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - ".github/actions/templates/avm-**" | ||
| - ".github/workflows/avm.template.module.yml" | ||
| - ".github/workflows/avm.utl.types.avm-common-types.yml" | ||
| - "avm/utl/types/avm-common-types/**" | ||
| - "avm/utilities/pipelines/**" | ||
| - "!avm/utilities/pipelines/platform/**" | ||
| - "!*/**/README.md" | ||
|
|
||
| env: | ||
| modulePath: "avm/utl/types/avm-common-types" | ||
| workflowPath: ".github/workflows/avm.utl.types.avm-common-types.yml" | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }} | ||
|
|
||
| jobs: | ||
| ########################### | ||
| # Initialize pipeline # | ||
| ########################### | ||
| job_initialize_pipeline: | ||
| runs-on: ubuntu-latest | ||
| name: "Initialize pipeline" | ||
| steps: | ||
| - name: "Checkout" | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| - name: "Set input parameters to output variables" | ||
| id: get-workflow-param | ||
| uses: ./.github/actions/templates/avm-getWorkflowInput | ||
| with: | ||
| workflowPath: "${{ env.workflowPath}}" | ||
| - name: "Get module test file paths" | ||
| id: get-module-test-file-paths | ||
| uses: ./.github/actions/templates/avm-getModuleTestFiles | ||
| with: | ||
| modulePath: "${{ env.modulePath }}" | ||
| outputs: | ||
| workflowInput: ${{ steps.get-workflow-param.outputs.workflowInput }} | ||
| moduleTestFilePaths: ${{ steps.get-module-test-file-paths.outputs.moduleTestFilePaths }} | ||
| psRuleModuleTestFilePaths: ${{ steps.get-module-test-file-paths.outputs.psRuleModuleTestFilePaths }} | ||
| modulePath: "${{ env.modulePath }}" | ||
|
|
||
| ############################## | ||
| # Call reusable workflow # | ||
| ############################## | ||
| call-workflow-passing-data: | ||
| name: "Run" | ||
| permissions: | ||
| id-token: write # For OIDC | ||
| contents: write # For release tags | ||
| needs: | ||
| - job_initialize_pipeline | ||
| uses: ./.github/workflows/avm.template.module.yml | ||
| with: | ||
| workflowInput: "${{ needs.job_initialize_pipeline.outputs.workflowInput }}" | ||
| moduleTestFilePaths: "${{ needs.job_initialize_pipeline.outputs.moduleTestFilePaths }}" | ||
| psRuleModuleTestFilePaths: "${{ needs.job_initialize_pipeline.outputs.psRuleModuleTestFilePaths }}" | ||
| modulePath: "${{ needs.job_initialize_pipeline.outputs.modulePath}}" | ||
| secrets: inherit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.