fix(gha): output headers cmd to stdout, not stderr #80
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
Previously, the GitHub Actions `::startgroup::` and `::endgroup` directives were being sent to stdout, but all command output from Copywrite was being sent to stderr. This caused an issue that was especially common for the `copywrite headers --plan` command, where the list of files missing headers would be partially included and partially excluded from the logging group. As a fix I set Cobra up to print to stdout by default, and updated the logger we send to the addlicense module to also use stdout. Ideally, we'd restructure logging entirely within the module, but I'm leaving that for a future PR.
dlaguerta
approved these changes
Jul 11, 2023
|
@dlaguerta do you happen to know what's going on with the failing build? Looks like it might be affecting everything due to a bump in goreleaser? |
CalebAlbers
added a commit
that referenced
this pull request
Nov 7, 2023
Previously, the `copywrite headers` command would output a lot of `[DEBUG] skipping file...` statements, esp. when large folders were excluded (looking at you, `NODE_MODULES`). This made for a poor experience, and was a bug introduced when I made #80 - as in an attempt to fix an issue with GHA log group directives and addlicense sending to stdout and stderr, respectively, I introduced a bug that ignored the `COPYWRITE_LOG_LEVEL` env var. This PR fixes that error while ensuring the GHA log grouping still works by redirecting the `cliLogger` we use throughout the headers cmd (and others) to stdout by default. This doesn't appear to be a large shift or change for other commands, but does make a big difference for the headers command.
1 task
CalebAlbers
added a commit
that referenced
this pull request
Nov 13, 2023
Previously, the `copywrite headers` command would output a lot of `[DEBUG] skipping file...` statements, esp. when large folders were excluded (looking at you, `NODE_MODULES`). This made for a poor experience, and was a bug introduced when I made #80 - as in an attempt to fix an issue with GHA log group directives and addlicense sending to stdout and stderr, respectively, I introduced a bug that ignored the `COPYWRITE_LOG_LEVEL` env var. This PR fixes that error while ensuring the GHA log grouping still works by redirecting the `cliLogger` we use throughout the headers cmd (and others) to stdout by default. This doesn't appear to be a large shift or change for other commands, but does make a big difference for the headers command.
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.
🛠️ Description
Previously, the GitHub Actions
::startgroup::and::endgroupdirectives were being sent to stdout, but all command output from Copywrite was being sent to stderr. This caused an issue that was especially common for thecopywrite headers --plancommand, where the list of files missing headers would be partially included and partially excluded from the logging group.As a fix I set Cobra up to print to stdout by default, and updated the logger we send to the addlicense module to also use stdout. Ideally, we'd restructure logging entirely within the module, but I'm leaving that for a future PR.
🔗 External Links
#79
👍 Definition of Done
🤔 Can be merged upon approval?
✅