Skip to content
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

runner: add task specific help command to --help #60

Merged
merged 1 commit into from
Jun 14, 2023

Conversation

ChenJesse
Copy link

@ChenJesse ChenJesse commented Jun 9, 2023

Since we have released flag support, we now support:
taskrunner [task] --help which gives rich details on the task like
description, supported flags.

looks like

[Usage]
        taskrunner [task...]
        taskrunner [task] --help
        taskrunner [option]

[Options]
  -config string
    	Configuration file to use
  -describe
    	Describe all tasks
  -ignore-cache
    	Ignore task invalidation cache
  -list
    	List all tasks except those marked "Hidden"
  -listAll
    	List all tasks including those marked as "Hidden"
  -non-interactive
    	Non-interactive mode (only applies when running the default set of tasks)
  -watch
    	Run in watch mode (only applies when passing custom tasks)

[Example Usage]
        `taskrunner mytask`
        `taskrunner mytask ---help`
        `taskrunner mytask1 mytask2`
        `taskrunner mytask --mode=dev`
        `taskrunner --config ./customconfig.json mytask --mode=dev`
        `taskrunner --list`

@ChenJesse ChenJesse force-pushed the jesse/taskrunner-help branch 5 times, most recently from 16097ae to c436c95 Compare June 9, 2023 15:57
@ChenJesse ChenJesse force-pushed the jesse/taskrunner-help branch 6 times, most recently from c024922 to ddac592 Compare June 12, 2023 17:47
runner.go Outdated Show resolved Hide resolved
Since we have released flag support, we now support:
`taskrunner [task] --help` which gives rich details on the task like
description, supported flags.

Let's also add some example invocations.
Copy link
Contributor

@toniihsia toniihsia left a comment

Choose a reason for hiding this comment

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

:catjam:

@ChenJesse ChenJesse merged commit 07547b9 into master Jun 14, 2023
@ChenJesse ChenJesse deleted the jesse/taskrunner-help branch June 14, 2023 19:45
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