Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[AVM Module Issue]: Change @allowed values in "kind" to lowercase to match actual values #3909

Closed
1 task done
sajense opened this issue Dec 10, 2024 · 3 comments · Fixed by #3911
Closed
1 task done

[AVM Module Issue]: Change @allowed values in "kind" to lowercase to match actual values #3909

sajense opened this issue Dec 10, 2024 · 3 comments · Fixed by #3911
Assignees
@pankajagrawal16 @tsc-buddy
Labels
Class: Resource Module 📦 This is a resource module Needs: Triage 🔍 Maintainers need to triage still Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue Type: Feature Request ➕ New feature or request

Comments

@sajense
Copy link

sajense commented Dec 10, 2024

Check for previous/existing GitHub issues

  • I have checked for previous/existing GitHub issues

Issue Type?

Feature Request

Module Name

avm/res/web/serverfarm

(Optional) Module Version

No response

Description

Current values allowed are using upper-case letters, which is causing a modify to happen at every run.

@description('Optional. Kind of server OS.')
@allowed([
 'App'
 'Elastic'
 'FunctionApp'
 'Windows'
 'Linux'
])
param kind string = 'App'

What-if output:

 ~ Microsoft.Web/serverfarms/asp-xxx-xxx [2022-09-01]
   ~ kind:                                 "linux" => "Linux"

The allowed decorator is case-sensitive, so values must be fixed in the module

@description('Optional. Kind of server OS.')
@allowed([
  'app'
  'elastic'
  'functionapp'
  'windows'
  'linux'
])
param kind string = 'app'

It's not causing a functional issue, it's just kind of annoying always seeing this in every pipeline run.

(Optional) Correlation Id

No response
@sajense sajense added Needs: Triage 🔍 Maintainers need to triage still Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue labels Dec 10, 2024
@microsoft-github-policy-service Microsoft GitHub Policy Service
Copy link

Important

The "Needs: Triage 🔍" label must be removed once the triage process is complete!

Tip

For additional guidance on how to triage this issue/PR, see the BRM Issue Triage documentation.

@avm-team-linter avm-team-linter bot added the Class: Resource Module 📦 This is a resource module label Dec 10, 2024
@avm-team-linter AVM Team Linter
Copy link

@sajense, thanks for submitting this issue for the avm/res/web/serverfarm module!

Important

A member of the @Azure/avm-res-web-serverfarm-module-owners-bicep or @Azure/avm-res-web-serverfarm-module-contributors-bicep team will review it soon!

@github-project-automation github-project-automation bot moved this to Needs: Triage in AVM - Module Issues Dec 10, 2024
@pankajagrawal16 pankajagrawal16 self-assigned this Dec 10, 2024
@pankajagrawal16
Copy link
Contributor

Hi @sajense Thanks for opening the issue. It makes sense. In order to be backward compatible, we can lowercase it inside module itself.

@pankajagrawal16 pankajagrawal16 mentioned this issue Dec 10, 2024
Merged
11 tasks
AlexanderSehr pushed a commit that referenced this issue Dec 13, 2024
@pankajagrawal16 @tsc-buddy
chore: lower case kind value to avoid diff everytime (#3911)
a0f7796 
## Description

<!--
>Thank you for your contribution !
> Please include a summary of the change and which issue is fixed.
> Please also include the context.
> List any dependencies that are required for this change.

Fixes #123
Fixes #456
Closes #123
Closes #456
-->

Closes #3909 

## Pipeline Reference

<!-- Insert your Pipeline Status Badge below -->

| Pipeline |
| -------- |
|
[![avm.res.web.serverfarm](https://github.com/pankajagrawal16/bicep-registry-modules/actions/workflows/avm.res.web.serverfarm.yml/badge.svg?branch=3909%2Flowecase-kind)](https://github.com/pankajagrawal16/bicep-registry-modules/actions/workflows/avm.res.web.serverfarm.yml)
|

## 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:
- [x] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [x] 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

## Checklist

- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [x] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [x] My corresponding pipelines / checks run clean and green without
any errors or warnings

<!-- Please keep up to date with the contribution guide at
https://aka.ms/avm/contribute/bicep -->

Co-authored-by: Buddy <[email protected]>
@github-project-automation github-project-automation bot moved this from Needs: Triage to Done in AVM - Module Issues Dec 13, 2024
anderseide pushed a commit to anderseide/avm-bicep-registry-modules that referenced this issue Dec 15, 2024
@pankajagrawal16 @tsc-buddy @anderseide
chore: lower case kind value to avoid diff everytime (Azure#3911)
1b16f2c 
## Description

<!--
>Thank you for your contribution !
> Please include a summary of the change and which issue is fixed.
> Please also include the context.
> List any dependencies that are required for this change.

Fixes Azure#123
Fixes Azure#456
Closes Azure#123
Closes Azure#456
-->

Closes Azure#3909 

## Pipeline Reference

<!-- Insert your Pipeline Status Badge below -->

| Pipeline |
| -------- |
|
[![avm.res.web.serverfarm](https://github.com/pankajagrawal16/bicep-registry-modules/actions/workflows/avm.res.web.serverfarm.yml/badge.svg?branch=3909%2Flowecase-kind)](https://github.com/pankajagrawal16/bicep-registry-modules/actions/workflows/avm.res.web.serverfarm.yml)
|

## 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:
- [x] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [x] 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

## Checklist

- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [x] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [x] My corresponding pipelines / checks run clean and green without
any errors or warnings

<!-- Please keep up to date with the contribution guide at
https://aka.ms/avm/contribute/bicep -->

Co-authored-by: Buddy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pankajagrawal16 pankajagrawal16

@tsc-buddy tsc-buddy

Labels
Class: Resource Module 📦 This is a resource module Needs: Triage 🔍 Maintainers need to triage still Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue Type: Feature Request ➕ New feature or request
Projects
AVM - Module Issues
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: lower case kind value to avoid diff everytime pankajagrawal16/bicep-registry-modules
3 participants
@pankajagrawal16 @tsc-buddy @sajense