feat(logger): add GHA-aware notices/warnings #557
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
kanadgupta
added
enhancement
kanadgupta
commented
Aug 1, 2022
| @@ -9,6 +9,7 @@ describe('#fetch()', () => { | |||
| // List of all GitHub Actions env variables: | |||
| // https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables | |||
| beforeEach(() => { | |||
| process.env.GITHUB_ACTION = '__repo-owner_name-of-action-repo'; | |||
There was a problem hiding this comment.
I added this to further simulate a GHA environment in our tests since this is the variable that ci-detect uses.
erunion
approved these changes
Aug 1, 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
Added some context-aware logging for notices and warnings (we were previously only doing this for if
rdmewould error out). This will surface certain logs for the user more nicely when it's being run in a GitHub Actions environment. We'll need this for the work in RM-4984.I also added
ci-detectinto the mix since we will also need that for RM-4984 and it feels a little less hairy to do our CI detection checks this way.🧬 QA & Testing
I tested out the annotations and confirmed that they show up! You can check it out here: https://github.com/readmeio/rdme/actions/runs/2778155329