Add --format flag to score-k8s generate CLI reference#307
Merged
mathieu-benoit merged 1 commit intoJul 4, 2026
Merged
Conversation
Signed-off-by: Abhishek <abhishekup082@gmail.com>
Contributor
Author
|
@mathieu-benoit as promised on score-spec/score-k8s#321, here's the doc update for the new |
mathieu-benoit
approved these changes
Jul 4, 2026
mathieu-benoit
left a comment
Contributor
There was a problem hiding this comment.
LGTM, thanks @Abhishek9639!
This file contains hidden or 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
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.
What is the motivation?
score-k8s 0.15.0 just shipped a new
--formatflag on thegeneratecommand (score-spec/score-k8s#321). After that PR was merged, @mathieu-benoit asked me to add the flag to the CLI reference once the release was out: score-spec/score-k8s#321 (comment). The page doesn't mention it yet, so anyone reading the docs today wouldn't know the flag exists.What does this change do?
Adds a
--formatentry to thegenerateflags section of the score-k8s CLI reference. It's a small addition: a one-line description and a bash example, same shape as the other flag entries on that page, placed in alphabetical order before--generate-namespace. The wording follows the flag's help text in 0.15.0: the output format can beyamlorkyaml, and it defaults toyamlso nothing changes for anyone who doesn't opt in.What is your testing strategy?
Docs-only change, no code. I checked the description against the released flag's
--helpoutput and kept the markdown consistent with the neighbouring entries so it renders the same way on the page.Is this related to any issues?
Have you read the Contributing Guidelines?