From 3f80a3b39e06ba5779ad13a655df5a50b277732d Mon Sep 17 00:00:00 2001 From: Andrey Nering Date: Sun, 16 Feb 2020 11:21:06 -0300 Subject: [PATCH] Improve documentation for included Taskfiles Follow-up of #292 --- docs/usage.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/usage.md b/docs/usage.md index 8ca7b5cc..47659001 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -124,6 +124,21 @@ namespace. So, you'd call `task docs:serve` to run the `serve` task from `documentation/Taskfile.yml` or `task docker:build` to run the `build` task from the `DockerTasks.yml` file. +### Directory of included Taskfile + +By default, included Taskfile's tasks are ran in the current directory, even +if the Taskfile is in another directory, but you can force its tasks to run +in another directory by using this alternative syntax: + +```yaml +version: '3' + +includes: + docs: + taskfile: ./docs/Taskfile.yml + dir: ./docs +``` + > The included Taskfiles must be using the same schema version the main > Taskfile uses.