Add Git configuration options for trace & debug #1228
Merged
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
ldennington
approved these changes
Apr 27, 2023
Contributor
ldennington
left a comment
ldennington
left a comment
There was a problem hiding this comment.
Looks good! Just a few nitpicky suggestions - the only main concern is the 404s on the links, but I suspect that's just an issue with GitHub's PR Files view.
|
|
||
| Defaults to tracing disabled. | ||
|
|
||
| **Also see: [GCM_TRACE][gcm-trace]** |
Contributor
There was a problem hiding this comment.
Links are resulting in 404s. Will be resolved once merged?
Contributor
Author
There was a problem hiding this comment.
Hmm.. they are correct.. so I assume some issue with the PR view.
| TryGetSetting(KnownEnvars.GcmTrace, | ||
| KnownGitCfg.Credential.SectionName, | ||
| KnownGitCfg.Credential.Trace, | ||
| out value) && !value.IsFalsey(); |
Contributor
There was a problem hiding this comment.
Maybe make this IsTruthy() to align with the IsDebuggingEnabled check above and the IsSecretTracingEnabled/IsMsalTracingEnabled checks below.
Contributor
Author
There was a problem hiding this comment.
We need to keep this to !IsFalsey because we can set this variable to something like a file path which is considered "enabled".
| Value | TryGetSetting |
IsTruthy |
IsFalsey |
TryGetSetting && !IsFalsey |
|---|---|---|---|---|
null |
❌ | ❌ | ❌ | ❌ |
"/tmp/file.txt" |
✅ | ❌ | ❌ | ✅ |
true/1/"yes"/"on" |
✅ | ✅ | ❌ | ✅ |
false/0/"no"/"off" |
✅ | ❌ | ✅ | ❌ |
Contributor
There was a problem hiding this comment.
Lovely truth table - explains very nicely, thank you!
Add options for enabling tracing and debugging in Git configuration. Today the below options were only supported via environment variable: - GCM_TRACE - GCM_TRACE_SECRETS - GCM_TRACE_MSAUTH - GCM_DEBUG
mjcheetham
force-pushed
the
config-trace
branch
from
23fa49e to
50837bf
Compare
mjcheetham
added a commit
that referenced
this pull request
May 2, 2023
**Changes:** - Support ports in URL-scoped config (#825) - Support URL-scoped enterprise default settings (#1149) - Add support for client TLS certificates (#1152) - Add TRACE2 support(#1131, #1151, #1156, #1162) - Better browser detection inside of WSL (#1148) - Handle expired OAuth refresh token for generic auth (#1196) - Target *-latest runner images in CI workflow (#1178) - Various bug fixes: - Ensure we create a WindowsProcessManager on Windows (#1146) - Ensure we start child processes created with ProcessManager (#1177) - Fix app path name of Windows dropping file extension (#1181) - Ensure we init IEnvironment before SessionManager (#1167) - git: consistently read from stdout before exit wait (#1136) - trace2: guard against null pipe client in dispose (#1135) - Make Avalonia UI the default Windows and move to in-process (#1207) - Add Git configuration options for trace & debug (#1228) - Transition from Nerdbank.GitVersioning to a version file (#1231) - Add support for using the current Windows user for WAM on DevBox (#1197) - Various documentation updates: - org-rename: update references to GitCredentialManager (#1141) - issue templates: remove core suffix (#1180) - readme: add link to project roadmap (#1204) - docs: add bitbucket app password requirements (#1213) - .net tool: clarify install instructions (#1126) - docs: call out different GCM install paths in WSL docs (#1168) - docs: add trace2 to config/env documentation (#1230)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add options for enabling tracing and debugging in Git configuration. Today the below options were only supported via environment variable:
GCM_TRACEGCM_TRACE_SECRETSGCM_TRACE_MSAUTHGCM_DEBUG