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

Refactor --output help text and deprecate --file. #2187

Merged
merged 3 commits into from
Oct 3, 2023

Conversation

sharief007
Copy link
Contributor

@sharief007 sharief007 commented Oct 2, 2023

Change Log

  • Added usage syntax to CLI help text for --output option for better understanding. The new help text looks like:
-o, --output stringArray       report output format (<format>=<file> to output to a file), formats=[syft-json github-json syft-table syft-text template cyclonedx-xml cyclonedx-json spdx-tag-value spdx-json] (default [syft-table])
  • Marked the --file option as deprecated, suggesting to use --output as an alternative. The new help text looks like:
--file string              file to write the default report output to (default is STDOUT) (DEPRECATED: use: output)  

Resolves: #2165

Signed-off-by: Mohammad Sharief Baig <shariefmohammad007@gmail.com>
Signed-off-by: Mohammad Sharief Baig <shariefmohammad007@gmail.com>
@kzantow
Copy link
Contributor

kzantow commented Oct 2, 2023

To fix the static analysis check, you can run make lint-fix

Signed-off-by: Mohammad Sharief Baig <shariefmohammad007@gmail.com>
Copy link
Contributor

@kzantow kzantow left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@kzantow kzantow merged commit 2187878 into anchore:main Oct 3, 2023
9 checks passed
GijsCalis pushed a commit to GijsCalis/syft that referenced this pull request Feb 19, 2024
Signed-off-by: Mohammad Sharief Baig <shariefmohammad007@gmail.com>
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.

Improve --output CLI help and deprecate --file
2 participants