Azure / Azure/ResourceModules

Align in-module folder structure to AVM

Open
#4,057 6 comments 0 reactions 2 assignees Claimed by @eriqua View on GitHub
[cat] modules [cat] utilities help wanted
Dominant language
PowerShell
Stars
737
Forks
436
Avg merge
10d 7h
Merged PRs (30d)
1

Description

Required changes ([AVM ref](https://azure.github.io/Azure-Verified-Modules/contributing/bicep/#directory-and-file-structure))
- [ ] Question: Should we add a `res` & `ptn` folder in the `modules` folder?
- Background: Otherwise we only have 'constructs' to rely on which are (to this day) not supported by pipelines & tools
- [x] #4182
- Rename folder into `e2e`
- Move folder into a new `tests` folder
- Update Initialize-Pipeline to support new test folder name
- Update Pester tests to support new test folder name
- Update reference to `main.bicep` in `main.test.bicep`
- Update reference to `.shared/.scripts`
- Update reference to `.shared/.templates`
- [x] #4183
- Rename `min` test folder to `defaults`
- Rename `common` test folder to `max`
- Create duplication of `common/max` folder and name it `waf-aligned` (don't forget do update the serviceShort too - if possible)
- [x] #4185
- [ ] Utilities (the following assumes to also update all scripts to be updated so they work with the folder structure of CARML (i.e., no avm folder)
- Add `Set-AVMModule` utility (ref #4067)
- Update `Set-ModuleReadMe` and related scripts
- Relocate PSRule & `module.test.ps1` similar to AVM in the `utilities/pipelines` folder
- Update `module.test.bicep`
- Relocate template & script patterns similar to what we did in AVM (currently located in the `modules/.shared` folder

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.