Add file based configuration. #121
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
This adds [git-config](https://git-scm.com/docs/git-config) based configuration for gitsign values. Caveats: - GITSIGN_CREDENTIAL_CACHE intentionally not supported since this is likely changing soon. - We do not use subsections (i.e. we use gitsign.issuer instead of gitsign.oidc.issuer). This gives us some wiggle room to add host based config later on similar to https://git-scm.com/docs/gitcredentials Signed-off-by: Billy Lynch <[email protected]>
imjasonh
approved these changes
Aug 23, 2022
eddiezane
approved these changes
Aug 23, 2022
| out.Issuer = o.Value | ||
| case "logPath": | ||
| out.LogPath = o.Value | ||
| } |
There was a problem hiding this comment.
I know git eats output but Is there a way you can warn about an unknown (or mistyped) value in the default case?
There was a problem hiding this comment.
There's a bit of a chicken and egg problem, since we use the config to set up some of the output writers (i.e. GITSIGN_LOG).
We could refactor just the tty input/output setup to capture this if we really wanted, but I'm also not too worried about it - this behavior is something that is present for most git configs (i.e. you can do git config --local gpg.foo bar and it won't complain), and it seems to be manageable for most people. We still have -v as a fall back to verify parsed values as a sanity check.
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.
Summary
This adds git-config based configuration for gitsign values.
Caveats:
likely changing soon (see Easier credential caching #98)
This gives us some wiggle room to add host based config later on
similar to https://git-scm.com/docs/gitcredentials
Signed-off-by: Billy Lynch [email protected]
Fixes #99
Release Note
Documentation
Will update once new release is cut. This is a backwards compatible change.