[Utilities] `Set-ModuleReadMe` Improved function identification regex #2294

AlexanderSehr · 2022-11-07T20:52:52Z

Description

Improved function identification regex in Set-ModuleReadMe script
Re-ran generation on all templates
Extended agent setup outpit
Added PowerShell installation as agents have 7.2.7 installed while our scripts require 7.3.0

Pipeline references

For module/pipeline changes, please create and attach the status badge of your successful run.

Pipeline

Type of Change

Please delete options that are not relevant.

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Update to documentation

github-actions · 2022-11-07T21:26:07Z

Unit Test Results

  1 files ±0   1 suites ±0 35s ⏱️ +7s
53 tests - 1 52 ✔️ - 1 1 💤 ±0 0 ❌ ±0
70 runs - 4 67 ✔️ - 4 3 💤 ±0 0 ❌ ±0

Results for commit ab394da. ± Comparison against base commit fc818d6.

This pull request removes 54 and adds 53 tests. Note that renamed tests count towards both.

/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Network/virtualNetworkGateways] used resource type [diagnosticsettings] should use one of the recent API version(s). Currently using [2021-05-01-preview]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Network/virtualNetworkGateways] used resource type [locks] should use one of the recent API version(s). Currently using [2017-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Network/virtualNetworkGateways] used resource type [publicIPAddresses] should use one of the recent API version(s). Currently using [2021-08-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Network/virtualNetworkGateways] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Network/virtualNetworkGateways] used resource type [virtualNetworkGateways] should use one of the recent API version(s). Currently using [2021-08-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.Network/virtualNetworkGateways] All apiVersion properties should be set to a static, hard-coded value
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.Network/virtualNetworkGateways] All non-required parameters in template file should not have description that start with "Required."
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.Network/virtualNetworkGateways] All parameters in parameters files exist in template file (deploy.json)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.Network/virtualNetworkGateways] All required parameters in template file (deploy.json) should exist in parameters files
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.Network/virtualNetworkGateways] CUA ID deployment should be present in the template
…

/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.AnalysisServices/servers] used resource type [diagnosticsettings] should use one of the recent API version(s). Currently using [2021-05-01-preview]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.AnalysisServices/servers] used resource type [locks] should use one of the recent API version(s). Currently using [2017-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.AnalysisServices/servers] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.AnalysisServices/servers] used resource type [servers] should use one of the recent API version(s). Currently using [2017-08-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] All apiVersion properties should be set to a static, hard-coded value
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] All non-required parameters in template file should not have description that start with "Required."
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] All parameters in parameters files exist in template file (deploy.json)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] All required parameters in template file (deploy.json) should exist in parameters files
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] CUA ID deployment should be present in the template
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] Conditional parameters' description should contain 'Required if' followed by the condition making the parameter required.
…

This pull request removes 1 skipped test and adds 1 skipped test. Note that renamed tests count towards both.

/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ File/folder tests..test folder.[Microsoft.Network/virtualNetworkGateways] *parameters.json files in the .test folder should be valid json

/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ File/folder tests..test folder.[Microsoft.AnalysisServices/servers] *parameters.json files in the .test folder should be valid json

utilities/tools/Set-ModuleReadMe.ps1

…ReadMeFunc

github-actions · 2022-11-17T13:27:42Z

Test Results

  1 files ±    0   1 suites ±0 40s ⏱️ - 1m 6s
53 tests - 115 52 ✔️ - 113 1 💤 - 2 0 ❌ ±0
70 runs - 115 67 ✔️ - 113 3 💤 - 2 0 ❌ ±0

Results for commit dd8ec34. ± Comparison against base commit acbf7ae.

This pull request removes 168 and adds 53 tests. Note that renamed tests count towards both.

/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.KeyVault/vaults/accessPolicies] used resource type [vaults/accessPolicies] should use one of the recent API version(s). Currently using [2021-06-01-preview]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.KeyVault/vaults/keys] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.KeyVault/vaults/keys] used resource type [vaults/keys] should use one of the recent API version(s). Currently using [2019-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.KeyVault/vaults/secrets] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.KeyVault/vaults/secrets] used resource type [vaults/secrets] should use one of the recent API version(s). Currently using [2019-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.KeyVault/vaults] used resource type [diagnosticsettings] should use one of the recent API version(s). Currently using [2021-05-01-preview]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.KeyVault/vaults] used resource type [locks] should use one of the recent API version(s). Currently using [2017-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.KeyVault/vaults] used resource type [privateEndpoints/privateDnsZoneGroups] should use one of the recent API version(s). Currently using [2022-05-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.KeyVault/vaults] used resource type [privateEndpoints] should use one of the recent API version(s). Currently using [2022-05-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.KeyVault/vaults] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
…

/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.AnalysisServices/servers] used resource type [diagnosticsettings] should use one of the recent API version(s). Currently using [2021-05-01-preview]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.AnalysisServices/servers] used resource type [locks] should use one of the recent API version(s). Currently using [2017-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.AnalysisServices/servers] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.AnalysisServices/servers] used resource type [servers] should use one of the recent API version(s). Currently using [2017-08-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] All apiVersion properties should be set to a static, hard-coded value
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] All non-required parameters in template file should not have description that start with "Required."
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] All parameters in parameters files exist in template file (deploy.json)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] All required parameters in template file (deploy.json) should exist in parameters files
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] CUA ID deployment should be present in the template
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.AnalysisServices/servers] Conditional parameters' description should contain 'Required if' followed by the condition making the parameter required.
…

This pull request removes 3 skipped tests and adds 1 skipped test. Note that renamed tests count towards both.

/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.KeyVault/vaults/keys] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.KeyVault/vaults/secrets] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ File/folder tests..test folder.[Microsoft.KeyVault/vaults] *parameters.json files in the .test folder should be valid json

/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ File/folder tests..test folder.[Microsoft.AnalysisServices/servers] *parameters.json files in the .test folder should be valid json

♻️ This comment has been updated with latest results.

eriqua

🆗

AlexanderSehr added 2 commits November 7, 2022 21:38

Small fixes

0c85745

Small fix

ab394da

AlexanderSehr linked an issue Nov 7, 2022 that may be closed by this pull request

[Bug Report]: Set-ModuleReadMe converts specific function in parameters incorrectly #2271

Closed

AlexanderSehr self-assigned this Nov 7, 2022

AlexanderSehr added the [cat] utilities category: utilities label Nov 7, 2022

Improved regex

c791b28

AlexanderSehr marked this pull request as ready for review November 7, 2022 21:23

AlexanderSehr requested a review from a team as a code owner November 7, 2022 21:23

AlexanderSehr enabled auto-merge (squash) November 7, 2022 21:24

AlexanderSehr added 4 commits November 11, 2022 18:08

Updated script to add missing depth statements

cf4de12

Updated readmes

557da52

Add. fixes

e98c7a1

Re-gen

1282a20

eriqua mentioned this pull request Nov 11, 2022

[Utilities] Updated Set-ModuleReadMe script to work with latest PowerShell version #2315

Merged

4 tasks

eriqua reviewed Nov 11, 2022

View reviewed changes

utilities/tools/Set-ModuleReadMe.ps1 Show resolved Hide resolved

AlexanderSehr requested a review from eriqua November 12, 2022 08:11

Merge branch 'users/alsehr/readMePSUpdate' into users/alsehr/2271_set…

94333ef

…ReadMeFunc

AlexanderSehr mentioned this pull request Nov 12, 2022

[Fixes] Fix DataProtection Backup Vaults #2307

Merged

7 tasks

Small update to script

4cefb77

AlexanderSehr marked this pull request as draft November 16, 2022 16:01

auto-merge was automatically disabled November 16, 2022 16:01
Pull request was converted to draft

AlexanderSehr added 7 commits November 16, 2022 17:10

typo

afd04ff

Merge branch 'main' into users/alsehr/2271_setReadMeFunc

6df9bb7

Updated to function detection

e00e5bb

Update regex

c2b9609

Further updates

a1ae4cd

Further refinement

01b43cc

Refreshed docs

e279e96

AlexanderSehr marked this pull request as ready for review November 17, 2022 08:10

AlexanderSehr enabled auto-merge (squash) November 17, 2022 12:15

AlexanderSehr added 5 commits November 17, 2022 15:45

Added output

fb72711

Added PS Installation

90fb554

Changed install

fcfe344

Update to latest

dd8ec34

Cleanup

6fe8dcf

eriqua approved these changes Nov 17, 2022

View reviewed changes

AlexanderSehr merged commit 136b994 into main Nov 17, 2022

AlexanderSehr deleted the users/alsehr/2271_setReadMeFunc branch November 17, 2022 17:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Utilities] `Set-ModuleReadMe` Improved function identification regex #2294

[Utilities] `Set-ModuleReadMe` Improved function identification regex #2294

AlexanderSehr commented Nov 7, 2022 •

edited

github-actions bot commented Nov 7, 2022

github-actions bot commented Nov 17, 2022 •

edited

eriqua left a comment

[Utilities] Set-ModuleReadMe Improved function identification regex #2294

[Utilities] Set-ModuleReadMe Improved function identification regex #2294

Conversation

AlexanderSehr commented Nov 7, 2022 • edited

Description

Pipeline references

Type of Change

github-actions bot commented Nov 7, 2022

Unit Test Results

github-actions bot commented Nov 17, 2022 • edited

Test Results

eriqua left a comment

Choose a reason for hiding this comment

[Utilities] `Set-ModuleReadMe` Improved function identification regex #2294

[Utilities] `Set-ModuleReadMe` Improved function identification regex #2294

AlexanderSehr commented Nov 7, 2022 •

edited

github-actions bot commented Nov 17, 2022 •

edited