Repository navigation
fix: accurate --deployment help, aliases, and --list for generate-docs - #1040
Merged
Merged
Conversation
agent delete deletes the whole agent when --deployment is unset, and agent promote rejects an unset --deployment, so the shared flag's "Defaults to production" was wrong for both. They now have their own flag, and promote requires it.
Each alias gets its own usage line and joins the options label, the way the docs.livekit.io CLI reference wrote them by hand (lk agent logs / lk agent tail).
Prints every command under a path that the reference documents: commands that are run, and groups with their own options. docs.livekit.io generates a partial for each, so a new command can't go missing from the reference.
Contributor
Author
|
lk-generate-docs-fixes.mp4 |
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.
Stacked on #1033. Addresses review feedback on the docs.livekit.io CLI reference that
lk generate-docsproduces (livekit/web#6531):--deploymentonagent deleteandagent promote: both used the shared flag, whose help says "Defaults to production". That's wrong for both:agent deletewithout--deploymentdeletes the whole agent, including production, andagent promotewithout it fails with "cannot promote production deployment". Each now has its own flag with accurate help, andpromotemarks it required, so urfave rejects a missing flag before any API call.generate-docsdropped them, so the reference lostlk agent tailandlk agent destroy. Each alias now gets its own usage line, and the options label names both (Options for \logs`/`tail``), matching how the reference wrote them by hand.generate-docs --list [command path...]: prints every command below a path that the reference documents: commands that are run, and command groups that take their own options. docs.livekit.io generates one partial per listed command, so new commands appear in its release PR instead of being skipped silently. That's how the reference missedlk agent simulate audio's--background-noise,--low-quality-microphone, and--packet-loss.How to verify
go test -tags portaudio_system ./cmd/lk/passes.