mirror of
https://github.com/go-task/task.git
synced 2026-06-25 05:35:56 +00:00
Run Taskfiles from sub/child directories (#920)
This commit is contained in:
@@ -55,6 +55,7 @@ There are some special variables that is available on the templating system:
|
||||
| `TASK` | The name of the current task. |
|
||||
| `ROOT_DIR` | The absolute path of the root Taskfile. |
|
||||
| `TASKFILE_DIR` | The absolute path of the included Taskfile. |
|
||||
| `USER_WORKING_DIR` | The absolute path of the directory `task` was called from. |
|
||||
| `CHECKSUM` | The checksum of the files listed in `sources`. Only available within the `status` prop and if method is set to `checksum`. |
|
||||
| `TIMESTAMP` | The date object of the greatest timestamp of the files listes in `sources`. Only available within the `status` prop and if method is set to `timestamp`. |
|
||||
|
||||
|
||||
@@ -52,6 +52,35 @@ committed version (`.dist`) while still allowing individual users to override
|
||||
the Taskfile by adding an additional `Taskfile.yml` (which would be on
|
||||
`.gitignore`).
|
||||
|
||||
### Running a Taskfile from a subdirectory
|
||||
|
||||
If a Taskfile cannot be found in the current working directory, it will walk up
|
||||
the file tree until it finds one (similar to how `git` works). When running Task
|
||||
from a subdirectory like this, it will behave as if you ran it from the
|
||||
directory containing the Taskfile.
|
||||
|
||||
You can use this functionality along with the special `{{.USER_WORKING_DIR}}`
|
||||
variable to create some very useful reusable tasks. For example, if you have a
|
||||
monorepo with directories for each microservice, you can `cd` into a
|
||||
microservice directory and run a task command to bring it up without having to
|
||||
create multiple tasks or Taskfiles with identical content. For example:
|
||||
|
||||
```yaml
|
||||
version: '3'
|
||||
|
||||
tasks:
|
||||
up:
|
||||
dir: '{{.USER_WORKING_DIR}}'
|
||||
preconditions:
|
||||
- test -f docker-compose.yml
|
||||
cmds:
|
||||
- docker-compose up -d
|
||||
```
|
||||
|
||||
In this example, we can run `cd <service>` and `task up` and as long as the
|
||||
`<service>` directory contains a `docker-compose.yml`, the Docker composition will be
|
||||
brought up.
|
||||
|
||||
## Environment variables
|
||||
|
||||
### Task
|
||||
|
||||
Reference in New Issue
Block a user