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

Suggestion: Update SilenceErrors note #3356

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

RothAndrew
Copy link
Contributor

If SilenceErrors: is false, Cobra will emit unstructured log lines. Since Zarf wants structured logs whenever possible it makes sense for this to be set to true. The value being true signifies that we will be emitting our own logs using slog when we are returning an error.

@RothAndrew RothAndrew requested review from a team as code owners December 20, 2024 00:52
Copy link

netlify bot commented Dec 20, 2024

Deploy Preview for zarf-docs canceled.

Name Link
🔨 Latest commit 0ff45cb
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/6765a2e1b2c02100087f1c87

@AustinAbro321
Copy link
Contributor

Thanks @RothAndrew, please follow the DCO instructions to sign your commit then we can merge

If `SilenceErrors:` is false, Cobra will emit unstructured log lines. Since Zarf wants structured logs whenever possible it makes sense for this to be set to true. The value being true signifies that we will be emitting our own logs using `slog` when we are returning an error.

Signed-off-by: Andy Roth <roth.andy@gmail.com>
@RothAndrew
Copy link
Contributor Author

@AustinAbro321 done

Copy link

codecov bot commented Dec 20, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/cmd/root.go 0.00% 1 Missing ⚠️
Files with missing lines Coverage Δ
src/cmd/root.go 0.00% <0.00%> (ø)

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.

2 participants