fix: reduce redundant git-call-failed log messages in upload-sarif#3959
Open
mvanhorn wants to merge 1 commit into
Open
fix: reduce redundant git-call-failed log messages in upload-sarif#3959mvanhorn wants to merge 1 commit into
mvanhorn wants to merge 1 commit into
Conversation
Change the log level of the "git call failed." message in `runGitCommand` from `core.info` to `core.debug` so repeated identical failures in non-git working directories no longer flood the normal output. Add a single `core.info` fallback notice in `getCommitOid` so callers still see one actionable message when git is unavailable. Update tests to assert the new debug-level logging. Fixes github#3383
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
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.
When
upload-sarifruns in a directory that is not a git repository,runGitCommandwas callingcore.infoon every git call failure. Since callers such asgetCommitOidanddetermineBaseBranchHeadCommitOidsilently swallow the exception and fall back to environment variables, the same "not a git repository" diagnostic was emitted multiple times per run, adding noise without adding value.This PR changes the log level in
runGitCommandfromcore.infotocore.debugso the full diagnostic is preserved for maintainers with debug logging enabled, but does not appear in normal output. A singlecore.infofallback notice is added ingetCommitOidso callers still see exactly one actionable message when git is unavailable.Fixes #3383.
Risk assessment
Which use cases does this change impact?
upload-sarifaction.How did/will you validate this change?
.test.tsfiles). ExistingdetermineBaseBranchHeadCommitOidtests have been updated to assertcore.debugis called instead ofcore.info. All 30 tests insrc/git-utils.test.tspass.If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist