-
Notifications
You must be signed in to change notification settings - Fork 17
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
Add action for checking documentation coverage #81
Merged
Conversation
This file contains 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
Contributor
stes
commented
Jul 9, 2022
•
edited
Loading
edited
- Properly pass the output. Reference: https://trstringer.com/github-actions-multiline-strings/ or even better Feature request: create wrapper to expose stdout and stderr as outputs terraform-compliance/github_action#7 (comment)
- Use continue on error to let the documentation test fail but keep moving with running the test
WIP. This PR checks doc coverage (but could also report other things) and then generates & posts a report. I think it would be great to get this ready to automatically test all tasks, with actionable outputs for the authors. |
This was referenced Jul 12, 2022
stes
commented
Jul 12, 2022
Docstring Coverage Report
RESULT: PASSED (minimum: 0.0%, actual: 100.0%) |
Once #86 is merged, we should update this PR and can then merge it, too. |