search

Azure / bicep

Bicep is a declarative language for describing and deploying Azure resources
MIT License
3.25k stars 754 forks source link

Linter rule should not trigger on description field #10308

Open StephenWeatherford opened 1 year ago

StephenWeatherford commented 1 year ago

from https://github.com/MicrosoftDocs/azure-docs/issues/107578 by @jagiraud

Currently the "no hardcoded environment URL" triggers on description field for parameters.

Example:

@description('Required. The full uri for the encrypt key from key vault. Example: https://<keyvaultname>.vault.azure.net/keys/<keyname>/<version>.

I see no value of enforcing this linter rule on metadata fields such as description. Can this be bypassed somehow?

Seems like a reasonable request. Are there any cases where people would want this rule to run on @description? What about other metadata tags?

stephaniezyen commented 1 year ago

Exclude all metadata