Description should be empty when it is missing in ModuleFile #769
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
This pull request enhances the handling of module file descriptions in the Markdown reader, improves test coverage for scenarios where descriptions are missing, and adds a new module file asset for testing purposes. The most important changes include refining the logic for handling missing descriptions, updating tests to reflect new functionality, and adding a new test asset.
Improvements to Markdown Reader Logic:
src/MarkdownReader/ModuleFileMarkdownReader.cs: Updated theGetModuleFileDescriptionFromMarkdownmethod to handle cases where descriptions are missing. Added diagnostic warnings when no description is found and ensured the method returns an empty string in such cases.Test Coverage Enhancements:
test/Pester/ImportMarkdownModuleFile.Tests.ps1: Added a new test case to verify that module files can be parsed even when the description is missing. Updated existing tests to account for the new module file asset, increasing the expected count of module files from 14 to 15. [1] [2]test/Pester/MeasurePlatyPSMarkdown.Tests.ps1: Updated test cases to reflect the addition of the new module file asset, increasing the expected count forModuleFilefrom 15 to 16 and forV1Schemafrom 51 to 52.Addition of New Test Asset:
test/Pester/assets/Microsoft.SystemCenter.ServiceManagementAutomation.md: Added a new module file asset for testing, including metadata and cmdlet definitions. This asset includes a missing description header to test edge cases.PR Context
Fixes #760