feat: introduce output format flag for zarf tools get-creds and zarf package list
#3415
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
✅ Deploy Preview for zarf-docs canceled.
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Codecov ReportAttention: Patch coverage is
|
AustinAbro321
commented
Jan 24, 2025
| if logFile != nil { | ||
| logFile.Pause() | ||
| defer logFile.Resume() | ||
| } |
There was a problem hiding this comment.
this was not ported over, but logFile is only used with the legacy logger, and since this now goes to stdout it doesn't go to the logfile anyway
mkcp
previously approved these changes
Jan 24, 2025
src/cmd/package.go
Outdated
| return err | ||
| } | ||
| fmt.Fprint(o.outputWriter, string(output)) | ||
| case "table": |
There was a problem hiding this comment.
Not a blocker, but the table rendering can be done in a reusable way with reflection. One example
| func newVersionOptions() *versionOptions { | ||
| return &versionOptions{ | ||
| outputFormat: "", | ||
| // TODO accept output writer as a parameter to the root Zarf command and pass it through here |
| cmd.Flags().StringVarP(&o.outputFormat, "output", "o", "", "Output format (yaml|json)") | ||
| cmd.Flags().VarP(&o.outputFormat, "output-format", "o", "Output format (yaml|json)") | ||
| cmd.Flags().VarP(&o.outputFormat, "output", "", "Output format (yaml|json)") | ||
| cmd.Flags().MarkDeprecated("output", "output is deprecated. Please use --output-format instead") |
| GetCredsKey string `json:"getCredsKey"` | ||
| } | ||
|
|
||
| // TODO Zarf state should be changed to have empty values when a service is not in use |
| return err | ||
| } | ||
| fmt.Fprint(out, string(output)) | ||
| case outputTable: |
There was a problem hiding this comment.
Non-blocking, but similar comment to above, this can be solved in a reusable way with reflection for table headers.
Signed-off-by: Austin Abro <[email protected]>
AustinAbro321
force-pushed
the
output-format
branch
from
f78df60 to
1e77aeb
Compare
Signed-off-by: Austin Abro <[email protected]>
Signed-off-by: Austin Abro <[email protected]>
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.
Description
Introduces the
--output-flagforzarf tools get-credsandzarf package list. Additionally deprecates the--outputflag on zarf version to be--output-format. There are other commands that print tables in the future such aszarf connect listandzarf dev lint.get-credsandlistwere chosen because the output of these commands is more likely to be used in automation.Related Issue
Relates to #3224
Checklist before merging