mpalmer / action-validator

Tool to validate GitHub Action and Workflow YAML files
GNU General Public License v3.0
277 stars 23 forks source link

Confusing variable name #2

Closed mathew-fleisch closed 2 years ago

mathew-fleisch commented 2 years ago

Hey I just tried out this tool out. Neat! One confusing bit when I first started was I didn't realize it was expecting a single file. It'd be nice to change the usage section in the help dialog to say something like path-to-action-yaml instead of <src> to make that more explicit. I have never coded in rust before, and I can't see where to make this change.

action-validator
error: The following required arguments were not provided:
    <src>

USAGE:
    action-validator [FLAGS] <src>

For more information try --help

to something like

action-validator
error: The following required arguments were not provided:
    <src>

USAGE:
    action-validator [FLAGS] <path_to_action_file>

For more information try --help
mpalmer commented 2 years ago

Yep, that's a fair call. Isn't tricky to fix.

mpalmer commented 2 years ago

Builds for v0.1.1 should be out in the next few minutes in the Releases, which expands the variable name to something less... terse.

mathew-fleisch commented 2 years ago

thanks!