This repository includes a library of mature and curated Bicep modules as well as a Continuous Integration (CI) environment leveraged for modules' validation and versioned publishing.
The CI environment supports both ARM and Bicep and can be leveraged using GitHub actions as well as Azure DevOps pipelines.
In between now and the release of version 0.11.0, the main branch is subject to several upcoming breaking changes that will affect all modules (e.g., the renaming of folders and files).
The rationale is an ongoing effort to prepare our modules for a release in the official Public Bicep Registry, forcing us to align the structural requirements.
For more details, please refer to the issue #3131.
- For introduction guidance visit the Wiki
- For guidance on which version of the code to leverage, see Disclaimer
- For information on contributing, see Contribution
- File an issue via GitHub Issues
- For reference documentation, visit Enterprise-Scale
- For an outline of the module features, visit Module overview
Note: To ensure the modules and environment work as expected, please ensure you are using the latest version of the used tools such as PowerShell and Bicep. Especially in case of the later, note, that you need to manually update the Bicep CLI. For further information, see our troubleshooting guide.
| Name | Status |
|---|---|
| Update API Specs file |  |
| Assign Pull Request to Author |  |
| Test - ConvertTo-ARMTemplate.ps1 |  |
| Clean up deployment history |  |
| Library PSRule pre-flight validation |  |
| Broken Links Check |  |
| Linter (audit) | /badge.svg){kind=icon} |
| Manage issues for failing pipelines |  |
| Update ReadMe Module Tables |  |
| Update Static Test Documentation |  |
| Sync Docs/Wiki |  |
Please note that CARML is constantly evolving and introducing new features. The main branch of this repository changes frequently and thus, it always contains the latest available version of the code. Some of the updates may introduce breaking changes as well.
- Default path: To avoid disruptions, use distinct versions available through releases.
- Early adopter path: If the risk of breaking changes is understood and accepted, you can use the code in the
mainbranch directly. However, the CARML team recommends against automatically pulling code frommain. It is always recommended to review changes before you pull them into your own repository.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
For specific guidelines on how to contribute to this repository please refer to the Contribution guide Wiki section.
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
Modules provided in this library have telemetry enabled by default. To learn more about this feature, please refer to the Telemetry article in the wiki.