quantecon/Check for Python Warnings
Scan HTML files for Python warnings within code cell outputs (avoiding false positives from text content)
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Oct 1, 2025
- License
- MIT
Pinned Snippet
uses: quantecon/action-check-warnings@9409f193f6f15fd3a92880e6c073292fa240aebf # v1.0.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| html-path | Path to directory containing HTML files to scan | no | . |
| warnings | Comma-separated list of warnings to check for | no | UserWarning,DeprecationWarning,PendingDeprecationWarning,SyntaxWarning,RuntimeWarning,FutureWarning,ImportWarning,UnicodeWarning,BytesWarning,ResourceWarning,EncodingWarning |
| exclude-warning | Comma-separated list of warnings to exclude from checking (can be a single warning or multiple warnings) | no | "" |
| fail-on-warning | Whether to fail the workflow if warnings are found | no | true |
| create-issue | Whether to create a GitHub issue when warnings are found | no | false |
| issue-title | Title for the GitHub issue when warnings are found | no | Python Warnings Found in Documentation Build |
| create-artifact | Whether to create a workflow artifact with the warning report | no | false |
| artifact-name | Name for the workflow artifact containing the warning report | no | warning-report |
| notify | GitHub username(s) to assign to the created issue (comma-separated for multiple users) | no | "" |
Outputs
| name | description |
|---|---|
| warnings-found | Whether warnings were found (true/false) |
| warning-count | Number of warnings found |
| warning-details | Details of warnings found |
| issue-url | URL of the created GitHub issue (if create-issue is enabled) |
| artifact-path | Path to the created artifact file (if create-artifact is enabled) |