feat: debugging support #446
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
This installs a couple packages and sets up a logger for usage in normal and GHA environments
can't wait to use optional chaining lol
erunion
requested changes
Feb 24, 2022
| * @link https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables | ||
| */ | ||
| module.exports = function isGHA() { | ||
| return process.env.GITHUB_ACTIONS === 'true'; |
There was a problem hiding this comment.
We can replace this with the ci-info library I'm pulling in for RM-3621 to do require('ci-info').GITHUB_ACTIONS. That checks the GITHUB_ACTIONS env variable and also has awareness if it's part of a pull request.
https://github.com/watson/ci-info/blob/master/vendors.json#L93-L96
Co-authored-by: Jon Ursenbach <[email protected]>
Use ci-info package here instead! Feedback: #446 (comment) Co-Authored-By: Jon Ursenbach <[email protected]>
This reverts commit 1d2fad0.
erunion
approved these changes
Feb 24, 2022
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.
🧰 Changes
Commands that now have debugging
loginlogoutwhoamiopenapivalidateswaggerdocsdocs:editversionsversions:createversions:updateversions:deleteoasopenHelper functions that now have debugging
fetch()handleRes()Obviously there are many other helper functions, but these are the only ones that felt necessary.
Additionally, I made a small enhancement to
bin/rdmeto output errors via the native GitHub Action annotation format so they're properly surfaced. You can see an example of this in this workflow run (and in the image below1).🧬 QA & Testing
No functional changes beyond migrating
isGHA()into its own file and enhancing the logging inbin/rdme(the results of which you can see in the annotation example above). Do tests pass? And can you see debug logs on this workflow run?Fixes RM-3451, RM-3544
Footnotes
Yes, the "Process completed with exit code 1" error is excessive and is bugging me as well, and no, I don't know how to get rid of it... I think this is an unfortunate by-product of going with the composite action route 😞 ↩