-
Notifications
You must be signed in to change notification settings - Fork 122
cmd/loop: update urfave/cli to v3, auto-generate loop CLI reference manual and man file #1013
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
Conversation
ae27cf6 to
f928b4f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Cool addition with the doc generation!
| autoloop timer. THIS MUST NOT BE USED IN A PROD ENVIRONMENT. | ||
| `, | ||
| Action: forceAutoloop, | ||
| Hidden: true, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This command is already hidden behind the dev build flag, but nothing wrong with adding extra hidden flag.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The man and the markdown are built using loop-debug binary built by make build. That target builds with "dev" tag.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! LGTM!!
| @@ -0,0 +1,80 @@ | |||
| {{ define "flags" }} | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is really cool!
It is not intended for prod use. Those who need it can still use it.
urfave/cli/v3 returns "" if an int flag is accessed using String getter.
urfave/cli/v3 returns "" if an int flag is accessed using String getter.
Previously it was parsed as a single JSON string. Now each hint is parsed individually.
Previous version validated the value of non-existent flag "static-loop-in". The value passed to loopd was correct though.
f928b4f to
71b62c0
Compare
|
Rebased |
71b62c0 to
ab8ea4a
Compare
|
Updated static loop in usage: Updated docs for |
3f2d803 to
eac8e7b
Compare
Produce the documentations in man .1 and markdown formats. The template for markdown was patched to removed column "Environment variables" Upstream PR: urfave/cli-docs#15 Also the input has to be pre-processed to remove nested "help" subcommands from each subcommand to improve readability. Upstream PR: urfave/cli-docs#16
eac8e7b to
9eddee7
Compare
|
Fixed documentation generation to put paths like CI was catching this with diffs like this: -\fB--loopdir\fP="": path to loop's base directory (default: /home/user/.loop)
+\fB--loopdir\fP="": path to loop's base directory (default: /home/runner/.loop) |
Summary
urfave/cli/v3, adjusted every command/action to the new APIloop man/loop markdownhelpers plus Make/Ci steps that regenerate manpages/markdown and verify docs stay up to date.forceautoloopcommand from end users.Testing
make buildloop manloop markdownmake docs-checkloopto make sure it works properly