Use Line property instead of Matches and re-throw errors in GitHub actions #25
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.
Pull Request
Issue
When Catesta detects missing comment-based help, it outputs the Matches property, shown below:
There's also a small issue I found when troubleshooting GitHub actions. The
Import-Module
error is not re-thrown, making it difficult to troubleshoot. Example:Description
It would be more useful to output the line that's missing documentation, as shown below:
Outputting the line property instead enables the user to quickly identify which documentation is missing.
With errors from
Import-Module
re-thrown, you'll see the following, as an example:License
By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.