Skip to content

Commit

Permalink
feat: added get tasks command
Browse files Browse the repository at this point in the history
Added a get tasks command, which lists all the project's tasks by
module.
  • Loading branch information
thsig committed Dec 21, 2018
1 parent 4421df4 commit 250315d
Show file tree
Hide file tree
Showing 14 changed files with 270 additions and 105 deletions.
15 changes: 15 additions & 0 deletions docs/reference/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,21 @@ Outputs the status of your environment.

garden get status

### garden get tasks

Lists the tasks defined in your project's modules.


##### Usage

garden get tasks [tasks]

##### Arguments

| Argument | Required | Description |
| -------- | -------- | ----------- |
| `tasks` | No | Specify task(s) to list. Use comma as a separator to specify multiple tasks.

### garden init

Initialize system, environment or other runtime components.
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,11 @@ module:
# Required.
name:

# A description of the task.
#
# Optional.
description:

# The names of any tasks that must be executed, and the names of any services that must be
# running, before this task is executed.
#
Expand Down
3 changes: 3 additions & 0 deletions examples/tasks/hello/garden.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,8 @@ module:
tasks:
- name: node-migration
command: [knex, migrate:latest]
description: Creates the users table.
dependencies:
- postgres
- name: foo-task
command: [echo hello]
1 change: 1 addition & 0 deletions examples/tasks/user/garden.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ module:
tasks:
- name: ruby-migration
command: [rake, db:migrate]
description: Populates the users table with a few records.
dependencies:
# node-migration creates the users table, which has to exist before we use
# ruby-migration to insert records into it.
Expand Down
Loading

0 comments on commit 250315d

Please sign in to comment.