[AVM Module Issue]: Set-AVMModule updates README.md with wrong sort order

[Agazoth]

Check for previous/existing GitHub issues

• I have checked for previous/existing GitHub issues

Issue Type?

Bug

Module Name

avm/res/storage/storage-account

(Optional) Module Version

No response

Description

When running Set-AVMModule -ModuleFolderPath .\avm\res\storage\storage-account\ -Recurse locally, the README.md file gets updated with a wrong sort order on the allowedCopyScope parameter.

(Optional) Correlation Id

No response

[avm-team-linter]

@Agazoth, thanks for submitting this issue for the avm/res/storage/storage-account module!

Important

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

[AlexanderSehr]

Hey @Agazoth,
thanks for raising this. I'll look into this issue.
Before I do, one question though - The order of what is wrong? 😄 Is it about the 'AllowedValues' in your screenshot? Just want to make sure I look at the correct spot 😉

[Agazoth]

Hey @Agazoth, thanks for raising this. I'll look into this issue. Before I do, one question though - The order of what is wrong? 😄 Is it about the 'AllowedValues' in your screenshot? Just want to make sure I look at the correct spot 😉

Thanks, Alexander.

Before running the Set-AVMModule command, 'AAD' was on line 2280 and 'PrivateLink' on line 2381. The screenshot is of those two lines after running the command.

There is a rule for keeping parameters in correct sort order. If I push the wrong sort order, the pipeline fails. If I switch the two parameters after running the Set-AVMModule command and push the code, the pipeline does not complain.

[AlexanderSehr]

Gotcha, thank you @Agazoth - I'll work on this as soon as I find a moment. Non-deterministic results can be a pretty big issue - hence the sorting.

[Agazoth]

I just realized, that this might be caused by my Danish regional settings. In Danish AA is equivalent to Å, which is the last letter in our alphabet.

If the sort order is fixed to en-us, that ought to solve the issue.

[AlexanderSehr]

Hey @Agazoth, coincidentally, I just wanted to link this to an issue from the original CARML CI: Azure/ResourceModules#3722

Given that you essentially just confirmed the same, this will make solving the issue a lot faster 😄 Thanks for the update.