Increase visibility of error message when action fails due to HTTP request error #81
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
The "arduino/report-size-deltas" action relies on the GitHub REST API. It makes HTTP requests to various API endpoints during each workflow run. It is expected that these requests might occasionally produce an exception due to transient network outages. For this reason, the action has special handling of exceptions. Previously, that exception handling code was configured to be triggered on any exception, even though it is specific to HTTP request errors. It is more appropriate to target it only to the specific urllib.error.HTTPError exception that results from an HTTP request error, leaving any other types of unexpected exceptions unhandled.
…quest error The "arduino/report-size-deltas" action relies on the GitHub REST API. It makes HTTP requests to various API endpoints during each workflow run. These requests might produce an exception due to transient network outages, misconfiguration of the workflow, or a problem with the action. This will cause the action's step in the workflow run to fail. The maintainer of the repository in which the action is used may then need to investigate the cause of the failure. Previously, the cause of the failure could only be determined by evaluating the workflow run logs, which are somewhat unfriendly due to containing the Python stack trace produced by the HTTP request exception. The significant error message is hereby made visible as an annotation on the workflow run summary page through the use of an "error" workflow command.
By default, pytest captures all output from the code during test execution. For unknown reasons, the creator of the original pytest configuration file which was reused for this project decided to disable that behavior. This resulted in any output from the code under test being shown in the test logs, making them very difficult to read and interpret. That configuration is hereby removed. After this change, script output from successful test runs will not be shown in the test logs. Since the output might be useful for troubleshooting test failures, it will be shown when a test fails, in a special section of the logs.
per1234
added
type: enhancement
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #81 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 740 745 +5
=========================================
+ Hits 740 745 +5 ☔ View full report in Codecov by Sentry. |
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.
The arduino/report-size-deltas action relies on the GitHub REST API. It makes HTTP requests to various API endpoints during each workflow run.
These requests might produce an exception due to transient network outages, misconfiguration of the workflow, or a problem with the action. This will cause the action's step in the workflow run to fail. The maintainer of the repository in which the action is used may then need to investigate the cause of the failure.
Previously, the cause of the failure could only be determined by evaluating the workflow run logs, which are somewhat unfriendly due to containing the Python stack trace produced by the HTTP request exception. The significant error message is here made visible as an annotation on the workflow run summary page through the use of an "error" workflow command: