Skip to content

[Fixes] Fixed Readme files and Pester tests after recent new line change#2132

Merged
ahmadabdalla merged 2 commits intomainfrom
users/ahmad/rd_bugFix
Sep 25, 2022
Merged

[Fixes] Fixed Readme files and Pester tests after recent new line change#2132
ahmadabdalla merged 2 commits intomainfrom
users/ahmad/rd_bugFix

Conversation

@ahmadabdalla
Copy link
Copy Markdown
Contributor

@ahmadabdalla ahmadabdalla commented Sep 24, 2022

Closes #2131

Description

Fixed an issue where the pester test validation is failing when attempting to validate the readme file of a module. This caused all modules static tests to fail and required to regenerate all the module readmes to fit the new parameter section extra line change

NOTE: Excluded the Synapse workspace module in this change as the template is not compiling for issues to related to this change.

Pipeline references

Pipeline
Automation: AutomationAccounts
Authorization: RoleAssignments
Authorization: RoleDefinitions
Compute: Images
Consumption: Budgets
EventGrid: System Topics
EventHub: Namespaces
KeyVault: Vaults
Network: ApplicationSecurityGroups

Type of Change

  • Bugfix (non-breaking change which fixes an issue)

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

@ahmadabdalla ahmadabdalla added bug Something isn't working [prio] high importance of the issue: high priority labels Sep 24, 2022
@ahmadabdalla ahmadabdalla self-assigned this Sep 24, 2022
@ahmadabdalla ahmadabdalla requested a review from a team as a code owner September 24, 2022 14:10
@ahmadabdalla ahmadabdalla enabled auto-merge (squash) September 24, 2022 14:18
Copy link
Copy Markdown
Contributor

@MariusStorhaug MariusStorhaug left a comment

Choose a reason for hiding this comment

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

Thank you for fixing this bug @ahmadabdalla. This was introduced by a change I did on the readme generator, which I did as we played around with DocFX during the hack. When displaying the readmes it failed to show the tables correctly, and that is due to it sticking more strictly to the MD definition.

@ahmadabdalla ahmadabdalla merged commit 5ad973d into main Sep 25, 2022
@ahmadabdalla ahmadabdalla deleted the users/ahmad/rd_bugFix branch September 25, 2022 00:58
@ahmadabdalla
Copy link
Copy Markdown
Contributor Author

Thank you @MariusStorhaug ☺️

@eriqua eriqua changed the title Fixed Readme files and Pester tests after recent new line change [Fixes] Fixed Readme files and Pester tests after recent new line change Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working [prio] high importance of the issue: high priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug Report]: Readme file - Parameter section causes Pester tests to fail

2 participants