Skip to content

Add --format flag to score-k8s generate CLI reference#307

Merged
mathieu-benoit merged 1 commit into
score-spec:mainfrom
Abhishek9639:docs-score-k8s-generate-format-flag
Jul 4, 2026
Merged

Add --format flag to score-k8s generate CLI reference#307
mathieu-benoit merged 1 commit into
score-spec:mainfrom
Abhishek9639:docs-score-k8s-generate-format-flag

Conversation

@Abhishek9639

Copy link
Copy Markdown
Contributor

What is the motivation?

score-k8s 0.15.0 just shipped a new --format flag on the generate command (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 --format entry to the generate flags 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 be yaml or kyaml, and it defaults to yaml so 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 --help output 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?

Signed-off-by: Abhishek <abhishekup082@gmail.com>
@Abhishek9639

Copy link
Copy Markdown
Contributor Author

@mathieu-benoit as promised on score-spec/score-k8s#321, here's the doc update for the new --format flag now that 0.15.0 is out. Small one, just the flag entry added to the generate section. Ready for review whenever you get a chance.
Thanks!

@mathieu-benoit mathieu-benoit self-requested a review July 4, 2026 10:53

@mathieu-benoit mathieu-benoit left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, thanks @Abhishek9639!

@mathieu-benoit mathieu-benoit merged commit c6acaaa into score-spec:main Jul 4, 2026
6 checks passed
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