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.

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

[Fixes] Updated the way child module readmes are referenced #2352

Merged
merged 9 commits into from
Nov 22, 2022

Conversation

AlexanderSehr
Copy link
Contributor

@AlexanderSehr AlexanderSehr commented Nov 22, 2022

Description

  • Updated the way child module readmes are referenced (now considers actual folder names)

Pipeline references

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

Pipeline
Network: PrivateDnsZones

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

Checklist

  • I'm sure there are no other open Pull Requests for the same update/change
  • My corresponding pipelines / checks run clean and green without any errors or warnings
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (readme)
  • I did format my code

@AlexanderSehr AlexanderSehr requested a review from a team as a code owner November 22, 2022 16:44
@AlexanderSehr AlexanderSehr added documentation Improvements or additions to documentation [cat] modules category: modules [cat] utilities category: utilities labels Nov 22, 2022
@AlexanderSehr AlexanderSehr enabled auto-merge (squash) November 22, 2022 16:46
@github-actions
Copy link

Test Results

    1 files  ±    0      1 suites  ±0   3m 42s ⏱️ + 3m 14s
393 tests +341  383 ✔️ +333  10 💤 +8  0 ±0 
400 runs  +338  389 ✔️ +330  11 💤 +8  0 ±0 

Results for commit 66926e1. ± Comparison against base commit 1cfeb3e.

This pull request removes 52 and adds 393 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.PowerBIDedicated/capacities] used resource type [capacities] should use one of the recent API version(s). Currently using [2021-01-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.PowerBIDedicated/capacities] used resource type [locks] should use one of the recent API version(s). Currently using [2016-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.PowerBIDedicated/capacities] 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 ‑ Deployment template tests.Deployment template tests.[Microsoft.PowerBIDedicated/capacities] 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.PowerBIDedicated/capacities] 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.PowerBIDedicated/capacities] 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.PowerBIDedicated/capacities] 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.PowerBIDedicated/capacities] 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.PowerBIDedicated/capacities] Conditional parameters' description should contain 'Required if' followed by the condition making the parameter required.
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.PowerBIDedicated/capacities] If delete lock is implemented, the template should have a lock parameter with the default value of ['']
…
/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/privateDnsZones/AAAA] used resource type [privateDnsZones/AAAA] should use one of the recent API version(s). Currently using [2020-06-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/privateDnsZones/AAAA] 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/privateDnsZones/A] used resource type [privateDnsZones/A] should use one of the recent API version(s). Currently using [2020-06-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/privateDnsZones/A] 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/privateDnsZones/CNAME] used resource type [privateDnsZones/CNAME] should use one of the recent API version(s). Currently using [2020-06-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/privateDnsZones/CNAME] 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/privateDnsZones/MX] used resource type [privateDnsZones/MX] should use one of the recent API version(s). Currently using [2020-06-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/privateDnsZones/MX] 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/privateDnsZones/PTR] used resource type [privateDnsZones/PTR] should use one of the recent API version(s). Currently using [2020-06-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/privateDnsZones/PTR] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
…
This pull request removes 2 skipped tests and adds 10 skipped tests. 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.PowerBIDedicated/capacities] 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.PowerBIDedicated/capacities] *parameters.json files in the .test folder should be valid json
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.Network/privateDnsZones/AAAA] 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.Network/privateDnsZones/A] 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.Network/privateDnsZones/CNAME] 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.Network/privateDnsZones/MX] 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.Network/privateDnsZones/PTR] 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.Network/privateDnsZones/SOA] 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.Network/privateDnsZones/SRV] 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.Network/privateDnsZones/TXT] 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.Network/privateDnsZones/virtualNetworkLinks] 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.Network/privateDnsZones] *parameters.json files in the .test folder should be valid json

Copy link
Contributor

@eriqua eriqua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🆗

@AlexanderSehr AlexanderSehr merged commit ea87711 into main Nov 22, 2022
@AlexanderSehr AlexanderSehr deleted the users/alsehr/readmelinxFix branch November 22, 2022 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[cat] modules category: modules [cat] utilities category: utilities documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request]: Fix module readme broken links for Microsoft.Network\privateDnsZones
2 participants