Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Git configuration options for trace & debug #1228

Merged
merged 1 commit into from
Apr 27, 2023

Conversation

mjcheetham
Copy link
Collaborator

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

Copy link
Contributor

@ldennington ldennington left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

docs/configuration.md Outdated Show resolved Hide resolved

Defaults to tracing disabled.

**Also see: [GCM_TRACE][gcm-trace]**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Links are resulting in 404s. Will be resolved once merged?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe make this IsTruthy() to align with the IsDebuggingEnabled check above and the IsSecretTracingEnabled/IsMsalTracingEnabled checks below.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 mjcheetham merged commit 179f3db into git-ecosystem:main Apr 27, 2023
7 checks passed
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)
@mjcheetham mjcheetham deleted the config-trace branch July 10, 2023 23:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants