Uplifted Github Actions Error Handling, Added Types & Removed Redundant GH Token Input #26
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
### TL;DR
Refactored the action to improve error handling, and ensure that if an action is skipped, it is clear to the customer why it happened.
### What changed?
- Split the workflow logic into separate files: `config.ts`, `graphiteService.ts`, and `main.ts`
- Added TypeScript interfaces for `RequestBody` and `ResponseBody`
- Added `core.info('Skip: xxx')` to functions to clarify what the action did (as it is not easy to see outside debug mode by default).
- Added validation for PR Number, to skip in circumstances the action is unrelated to a PR (such as running on main).
- Removed redundant `github_token` from action input
- Added Timeout Handling for the Graphite Service Request using controller signals & set max timeout to 5m.
- Updated README to reflect changes in action usage
rorychatterton
changed the title
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.
TL;DR
Refactored the action to improve error handling, and ensure that if an action is skipped, it is clear to the customer why it happened.
What changed?
core.info('Skip: xxx')to functions to clarify what the action did (as it is not easy to see outside debug mode by default).i.e.
i.e.
Split the workflow logic into separate files:
config.ts,graphiteService.ts, andmain.tsAdded TypeScript interfaces for
RequestBodyandResponseBodyRemoved redundant
github_tokenfrom action input. See action.ymlAdded Timeout Handling for the Graphite Service Request using controller signals & set max timeout to 5m. See config.ts & graphiteService.ts
Updated README to reflect changes in action usage