Azure / Azure/bicep

Introduce option to exclude metadata and/or descriptions in compiled ARM

Open
#12,919 9 comments 6 reactions 0 assignees View on GitHub
enhancement Needs: Upvote
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 21m
Merged PRs (30d)
79

Description

**Is your feature request related to a problem? Please describe.**
We like the introduction of metadata within our BICEP deployments. Especially the combination with descriptions and markdown introduced a perfect way to document our deployments / features with our team. The problem with this is, we only need this documentation within our bicep file. We are now in a situation that we cannot deploy our solution(s) because the compiled ARM contains so much documentation (due child templates etc) that we manually have to remove all ARM/json metadata and description properties.

We need to keep an eye on the ARM deployment limit: https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/best-practices#template-limits

**Describe the solution you'd like**
As known from other programming languages, I would like to see an option (or default behaviour) that bicep compilation results in an ARM template without the descriptions and/or metadata.

Contributor guide

Open the contributing guide

Research direction

No source files, tests, or compiler entry points are named. Start by reviewing the issue requirements and Azure ARM template limits, then trace how Bicep compilation emits metadata and descriptions. Done means an agreed option or behavior can omit those properties while producing deployable ARM templates within the limits.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
cloud, infrastructure
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.