docs: add "cyclonedx-json" to output formats #1252
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
kzantow
reviewed
Apr 26, 2023
README.md
Outdated
| Where the `format`s available are: | ||
| Where the `formats` available are: |
There was a problem hiding this comment.
nit: this should probably not be code-quoted at all
There was a problem hiding this comment.
Well, the format is mentioned as an arg, so it is worth to highlight it somehow. But the existing way it looks a bit weird for my taste, the formats looks better but make it less consistent IMO.
So, should I get rid of quotes at all?
There was a problem hiding this comment.
I'd say to just get rid of the code quotes, as it's not exactly code or leave it as is -- it's just used in that example as format, not formats. Also, there's no --format option (it's --output / -o).
There was a problem hiding this comment.
@kzantow alright, the quotes removed.
Signed-off-by: HNKNTA <hnknta@gmail.com>
kzantow
approved these changes
May 2, 2023
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.
The output format is already supported:
supported formats are: [json table cyclonedx cyclonedx-json sarif template]CycloneDX 1.4 is also there:
#591