使い方
はじめに
プロジェクトのルートにTaskfile.yml
というファイルを作成します。 cmds
属性にはタスクのコマンドを記載する必要があります。 以下の例はGoアプリをコンパイルするタスクと、esbuildを使って複数のCSSファイルを結合・小さくして1つのファイルにするタスクがあります。
version: '3'
tasks:
build:
cmds:
- go build -v -i main.go
assets:
cmds:
- esbuild --bundle --minify css/index.css > public/bundle.css
タスクは以下のように簡単に実行できます:
task assets build
Taskはmvdan.cc/shというネイティブなGo shインタプリタを使用しています。 なのでsh/bashコマンドを書いても、Windowsのようなsh
やbash
が無いような環境でも動かすことが可能です。 実行可能なファイルはOSからアクセスできる場所、もしくはPATH内にある必要があることを覚えておいてください。
タスク名を省略すると、"default"が実行されます。
サポートされているファイル名
Taskは以下のような優先順位でファイルを探します:
- Taskfile.yml
- taskfile.yml
- Taskfile.yaml
- taskfile.yaml
- Taskfile.dist.yml
- taskfile.dist.yml
- Taskfile.dist.yaml
- taskfile.dist.yaml
.dist
が存在する意図は、プロジェクトが1つの固定されたバージョン(.dist
)を持つ一方で、個々のユーザーがTaskfile.yml
を追加することでTaskfileを上書きできるようにすることです(個々が追加したTaskfileは.gitignore
に追加されている)
サブディレクトリからTaskfileを実行する
カレントワーキングディレクトリからTaskfileが見つからなかったときは、見つかるまでファイルツリーを走査します(git
の動きに似ています)。 このようにタスクをサブディレクトリで実行すると、Taskfileがあるディレクトリから実行したかのように動きます。
このような機能を特別な{{.USER_WORKING_DIR}}
変数を使うことで、非常に便利で再利用可能なタスクを作成できます。 例えば、各マイクロサービスごとのディレクトリがあるモノリポがある場合、同じ内容の複数のタスクやTaskfileを作らずに、マイクロサービスのディレクトリにcd
で移動し、タスクコマンドを実行することができます。 例:
version: '3'
tasks:
up:
dir: '{{.USER_WORKING_DIR}}'
preconditions:
- test -f docker-compose.yml
cmds:
- docker-compose up -d
上記の例では、cd <service>
とtask up
を実行すると、<service>
ディレクトリにdocker-copmose.yml
があれば、Docker compositionが立ち上がります。
グローバルなTaskfileを実行する
--global
(エイリアス -g
) フラグと一緒にTaskを実行すると、ワーキングディレクトリの代わりにホームディレクトリからTaskfileを探します。 つまり、Taskは$HOME/{T,t}askfile.{yml,yaml}
にマッチするファイルを探します。
これはシステム内のどこからでも自動化処理を実行可能にする便利な機能です!
グローバルなTaskfileを-g
で実行するとき、タスクはワーキンクディレクトリではなく、デフォルトでは$HOME
ディレクトリで実行されます!
前述したように、{{.USER_WORKING_DIR}}
という特別な変数は非常に便利で、task -g
を呼び出しているディレクトリで実行させることができます。
version: '3'
tasks:
from-home:
cmds:
- pwd
from-working-directory:
dir: '{{.USER_WORKING_DIR}}'
cmds:
- pwd
環境変数
タスク
env
を使用して特定のタスクにカスタム環境変数を設定できます:
version: '3'
tasks:
greet:
cmds:
- echo $GREETING
env:
GREETING: Hey, there!
また、すべてのタスクに適用できるグローバルな環境変数を設定することもできます:
version: '3'
env:
GREETING: Hey, there!
tasks:
greet:
cmds:
- echo $GREETING
env
は変数と同様に、シェルコマンドからの出力を取得して展開することが可能です。詳細は変数セクションを参照してください。
.envファイル
dotenv:
設定を使用してTaskに.env
のようなファイルを読み込ませることもできます:
KEYNAME=VALUE
ENDPOINT=testing.com
version: '3'
env:
ENV: testing
dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env']
tasks:
greet:
cmds:
- echo "Using $KEYNAME and endpoint $ENDPOINT"
dotenvファイルはタスクレベルでも使用可能です:
version: '3'
env:
ENV: testing
tasks:
greet:
dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env']
cmds:
- echo "Using $KEYNAME and endpoint $ENDPOINT"
タスクレベルで明示的に定義された環境変数は、dotenvで読み込んだ変数を上書きします:
version: '3'
env:
ENV: testing
tasks:
greet:
dotenv: ['.env', '{{.ENV}}/.env.', '{{.HOME}}/.env']
env:
KEYNAME: DIFFERENT_VALUE
cmds:
- echo "Using $KEYNAME and endpoint $ENDPOINT"
インクルードされたTaskfile内では、dotenv
設定が現在は使えないことに注意してください。
他のTaskfileをインクルードする
異なるプロジェクト(Taskfile)間でタスクを共有したい場合、includes
キーワードを利用して他のTaskfileをインクルードするためのインポートメカニズムを利用できます。
version: '3'
includes:
docs: ./documentation # will look for ./documentation/Taskfile.yml
docker: ./DockerTasks.yml
指定されたTaskfileに記述されたタスクは、指定された名前空間で利用できるようになります。 なので、documentation/Taskfile.yml
からserve
タスクを実行するには、task docs:serve
を呼び、DockerTasks.yml
からbuild
タスクを実行するには、task docker:build
を呼び出します。
相対パスはインクルードするTaskfileが含まれているディレクトリに対して解決されます。
OS固有のTaskfile
version: '2'
では、taskはTaskfile_{{OS}}.yml
が存在する場合、自動的にインクルードします。(例えば: Taskfile_windows.yml
、Taskfile_linux.yml
、Taskfile_darwin.yml
など) この挙動は少し分かりづらかったため、バージョン3で削除されましたが、これらのファイルを明示的にインポートすることで同様の挙動を持たせることができます。
version: '3'
includes:
build: ./Taskfile_{{OS}}.yml
インクルードされたTaskfileのディレクトリ
デフォルトでは、インクルードされたTaskfileのタスクは、Taskfileが別のディレクトリにあったとしても、現在のディレクトリで実行されます。 ですが、代替構文を利用することで、強制的にタスクを別のディレクトリで実行させることができます:
version: '3'
includes:
docs:
taskfile: ./docs/Taskfile.yml
dir: ./docs
インクルードされるTaskfileは、メインのTaskfileが使用しているスキーマバージョンと同様のものである必要があります。
任意のインクルード
オプショナルとしてマークされたインクルードは、インクルードされるファイルが見つからない場合でも、タスクの実行を通常通り続行させます。
version: '3'
includes:
tests:
taskfile: ./tests/Taskfile.yml
optional: true
tasks:
greet:
cmds:
- echo "This command can still be successfully executed if
./tests/Taskfile.yml does not exist"
内部のインクルード
インターナルとしてマークされたインクルードは、インクルードされるファイルの全てのタスクもインターナルとします(下記の インターナルタスクセクションを参照)。 これはユーザーが直接使用することを意図していないユーティリティタスクをインクルードする際に便利です。
version: '3'
includes:
tests:
taskfile: ./taskfiles/Utils.yml
internal: true
インクルードされるTaskfileの変数
Taskfileをインクルードする際に変数を使用することもできます。 これは一度に複数回インクルードするような再利用可能なTaskfileを持つのに便利です。
version: '3'
includes:
backend:
taskfile: ./taskfiles/Docker.yml
vars:
DOCKER_IMAGE: backend_image
frontend:
taskfile: ./taskfiles/Docker.yml
vars:
DOCKER_IMAGE: frontend_image
ネームスペースのエイリアス
Taskfileをインクルードする際は、ネームスペースにエイリアス
のリストを渡すことができます。 これはタスクエイリアスと同じように機能し、短くてタイプしやすいコマンドを使用するために一緒に使うことができます。
version: '3'
includes:
generate:
taskfile: ./taskfiles/Generate.yml
aliases: [gen]
インクルードされたTaskfileで宣言された変数は、インクルードしているTaskfile内の変数よりも優先されます! インクルードされたTaskfileの変数を上書き可能にしたい場合は、default関数を使用してください: MY_VAR: '{{.MY_VAR | default "my-default-value"}}'
。
インターナルタスク
内部タスクはユーザーが直接呼び出すことができないタスクです。 task --list|--list-all
を実行したときの出力に表示されません。 他のタスクは通常通り内部タスクを呼び出すことができます。 これはコマンドライン上で明確な用途を持たないが、再利用可能で関数のようなタスクを作成するのに便利です。
version: '3'
tasks:
build-image-1:
cmds:
- task: build-image
vars:
DOCKER_IMAGE: image-1
build-image:
internal: true
cmds:
- docker build -t {{.DOCKER_IMAGE}} .
タスクディレクトリ
デフォルトでは、タスクはTaskfileが配置されているディレクトリで実行されます。 ですが、dir:
を指定することでタスクを簡単に別のディレクトリで実行させることができます。
version: '3'
tasks:
serve:
dir: public/www
cmds:
# run http server
- caddy
ディレクトリが存在しない場合、task
が作成します。
タスクの依存関係
依存関係は並列して実行されるため、実行されるタスクの依存関係が互いに依存しないようにする必要があります。 もしタスクを逐次実行するようにしたい場合は、下記の別のタスクを呼び出すセクションを参照してください。
他のタスクに依存するタスクがあるかもしれません。 deps
にそれらを指定することで、親タスクを実行する前に自動で実行されるようになります。
version: '3'
tasks:
build:
deps: [assets]
cmds:
- go build -v -i main.go
assets:
cmds:
- esbuild --bundle --minify css/index.css > public/bundle.css
上記の例では、task build
を実行すると、assets
は常にbuild
前に実行されます。
タスクは、自身のコマンドを持たずに、グループ化するためだけの依存関係のみを持たせることができます。
version: '3'
tasks:
assets:
deps: [js, css]
js:
cmds:
- esbuild --bundle --minify js/index.js > public/bundle.js
css:
cmds:
- esbuild --bundle --minify css/index.css > public/bundle.css
依存関係が複数ある場合、常に並列で実行されることでパフォーマンスが向上します。
コマンドラインで--parallel
フラグ(エイリアス -p
)を使用して、指定されたタスクを並列して実行することができます。 例: task --parallel js css
。
依存関係に情報を渡したい場合は、別のタスクを呼び出すのと同じ方法で行うことができます。
version: '3'
tasks:
default:
deps:
- task: echo_sth
vars: { TEXT: 'before 1' }
- task: echo_sth
vars: { TEXT: 'before 2' }
silent: true
cmds:
- echo "after"
echo_sth:
cmds:
- echo {{.TEXT}}
プラットフォーム固有のタスクとコマンド
タスクの実行を明示的なプラットフォームに制限したい場合は、platforms:
キーを使用することができます。 タスクは特定のOS、アーキテクチャ、またはその両方の組み合わせに制限させることができます。 一致しない場合、タスクまたはコマンドはスキップされ、エラーは発生しません。
OSまたはArchとして許可されている値はここでGo言語によって定義されている有効なGOOS
とGOARCH
の値らです。
以下のbuild-windows
タスクはWindowsと任意のアーキテクチャで実行されます:
version: '3'
tasks:
build-windows:
platforms: [windows]
cmds:
- echo 'Running command on Windows'
以下のように特定のアーキテクチャに制限することもできます:
version: '3'
tasks:
build-windows-amd64:
platforms: [windows/amd64]
cmds:
- echo 'Running command on Windows (amd64)'
また、特定のアーキテクチャのみに制限することも可能です:
version: '3'
tasks:
build-amd64:
platforms: [amd64]
cmds:
- echo 'Running command on amd64'
複数のプラットフォームは以下のように指定できます:
version: '3'
tasks:
build:
platforms: [windows/amd64, darwin]
cmds:
- echo 'Running command on Windows (amd64) and macOS'
それぞれのコマンドも特定のプラットフォームに制限することが可能です:
version: '3'
tasks:
build:
cmds:
- cmd: echo 'Running command on Windows (amd64) and macOS'
platforms: [windows/amd64, darwin]
- cmd: echo 'Running on all platforms'
別のタスクを呼び出す
When a task has many dependencies, they are executed concurrently. This will often result in a faster build pipeline. However, in some situations, you may need to call other tasks serially. In this case, use the following syntax:
version: '3'
tasks:
main-task:
cmds:
- task: task-to-be-called
- task: another-task
- echo "Both done"
task-to-be-called:
cmds:
- echo "Task to be called"
another-task:
cmds:
- echo "Another task"
Using the vars
and silent
attributes you can choose to pass variables and toggle silent mode on a call-by-call basis:
version: '3'
tasks:
greet:
vars:
RECIPIENT: '{{default "World" .RECIPIENT}}'
cmds:
- echo "Hello, {{.RECIPIENT}}!"
greet-pessimistically:
cmds:
- task: greet
vars: { RECIPIENT: 'Cruel World' }
silent: true
The above syntax is also supported in deps
.
NOTE: If you want to call a task declared in the root Taskfile from within an included Taskfile, add a leading :
like this: task: :task-name
.
Prevent unnecessary work
By fingerprinting locally generated files and their sources
If a task generates something, you can inform Task the source and generated files, so Task will prevent running them if not necessary.
version: '3'
tasks:
build:
deps: [js, css]
cmds:
- go build -v -i main.go
js:
cmds:
- esbuild --bundle --minify js/index.js > public/bundle.js
sources:
- src/js/**/*.js
generates:
- public/bundle.js
css:
cmds:
- esbuild --bundle --minify css/index.css > public/bundle.css
sources:
- src/css/**/*.css
generates:
- public/bundle.css
sources
and generates
can be files or file patterns. When given, Task will compare the checksum of the source files to determine if it's necessary to run the task. If not, it will just print a message like Task "js" is up to date
.
If you prefer this check to be made by the modification timestamp of the files, instead of its checksum (content), just set the method
property to timestamp
.
version: '3'
tasks:
build:
cmds:
- go build .
sources:
- ./*.go
generates:
- app{{exeExt}}
method: timestamp
In situations where you need more flexibility the status
keyword can be used. You can even combine the two. See the documentation for status for an example.
By default, task stores checksums on a local .task
directory in the project's directory. Most of the time, you'll want to have this directory on .gitignore
(or equivalent) so it isn't committed. (If you have a task for code generation that is committed it may make sense to commit the checksum of that task as well, though).
If you want these files to be stored in another directory, you can set a TASK_TEMP_DIR
environment variable in your machine. It can contain a relative path like tmp/task
that will be interpreted as relative to the project directory, or an absolute or home path like /tmp/.task
or ~/.task
(subdirectories will be created for each project).
export TASK_TEMP_DIR='~/.task'
Each task has only one checksum stored for its sources
. If you want to distinguish a task by any of its input variables, you can add those variables as part of the task's label, and it will be considered a different task.
This is useful if you want to run a task once for each distinct set of inputs until the sources actually change. For example, if the sources depend on the value of a variable, or you if you want the task to rerun if some arguments change even if the source has not.
The method none
skips any validation and always run the task.
For the checksum
(default) or timestamp
method to work, it is only necessary to inform the source files. When the timestamp
method is used, the last time of the running the task is considered as a generate.
Using programmatic checks to indicate a task is up to date
Alternatively, you can inform a sequence of tests as status
. If no error is returned (exit status 0), the task is considered up-to-date:
version: '3'
tasks:
generate-files:
cmds:
- mkdir directory
- touch directory/file1.txt
- touch directory/file2.txt
# test existence of files
status:
- test -d directory
- test -f directory/file1.txt
- test -f directory/file2.txt
Normally, you would use sources
in combination with generates
- but for tasks that generate remote artifacts (Docker images, deploys, CD releases) the checksum source and timestamps require either access to the artifact or for an out-of-band refresh of the .checksum
fingerprint file.
Two special variables {{.CHECKSUM}}
and {{.TIMESTAMP}}
are available for interpolation within status
commands, depending on the method assigned to fingerprint the sources. Only source
globs are fingerprinted.
Note that the {{.TIMESTAMP}}
variable is a "live" Go time.Time
struct, and can be formatted using any of the methods that time.Time
responds to.
See the Go Time documentation for more information.
You can use --force
or -f
if you want to force a task to run even when up-to-date.
Also, task --status [tasks]...
will exit with a non-zero exit code if any of the tasks are not up-to-date.
status
can be combined with the fingerprinting to have a task run if either the the source/generated artifacts changes, or the programmatic check fails:
version: '3'
tasks:
build:prod:
desc: Build for production usage.
cmds:
- composer install
# Run this task if source files changes.
sources:
- composer.json
- composer.lock
generates:
- ./vendor/composer/installed.json
- ./vendor/autoload.php
# But also run the task if the last build was not a production build.
status:
- grep -q '"dev": false' ./vendor/composer/installed.json
Using programmatic checks to cancel the execution of a task and its dependencies
In addition to status
checks, preconditions
checks are the logical inverse of status
checks. That is, if you need a certain set of conditions to be true you can use the preconditions
stanza. preconditions
are similar to status
lines, except they support sh
expansion, and they SHOULD all return 0.
version: '3'
tasks:
generate-files:
cmds:
- mkdir directory
- touch directory/file1.txt
- touch directory/file2.txt
# test existence of files
preconditions:
- test -f .env
- sh: '[ 1 = 0 ]'
msg: "One doesn't equal Zero, Halting"
Preconditions can set specific failure messages that can tell a user what steps to take using the msg
field.
If a task has a dependency on a sub-task with a precondition, and that precondition is not met - the calling task will fail. Note that a task executed with a failing precondition will not run unless --force
is given.
Unlike status
, which will skip a task if it is up to date and continue executing tasks that depend on it, a precondition
will fail a task, along with any other tasks that depend on it.
version: '3'
tasks:
task-will-fail:
preconditions:
- sh: 'exit 1'
task-will-also-fail:
deps:
- task-will-fail
task-will-still-fail:
cmds:
- task: task-will-fail
- echo "I will not run"
Limiting when tasks run
If a task executed by multiple cmds
or multiple deps
you can control when it is executed using run
. run
can also be set at the root of the Taskfile to change the behavior of all the tasks unless explicitly overridden.
Supported values for run
:
always
(default) always attempt to invoke the task regardless of the number of previous executionsonce
only invoke this task once regardless of the number of referenceswhen_changed
only invokes the task once for each unique set of variables passed into the task
version: '3'
tasks:
default:
cmds:
- task: generate-file
vars: { CONTENT: '1' }
- task: generate-file
vars: { CONTENT: '2' }
- task: generate-file
vars: { CONTENT: '2' }
generate-file:
run: when_changed
deps:
- install-deps
cmds:
- echo {{.CONTENT}}
install-deps:
run: once
cmds:
- sleep 5 # long operation like installing packages
Ensuring required variables are set
If you want to check that certain variables are set before running a task then you can use requires
. This is useful when might not be clear to users which variables are needed, or if you want clear message about what is required. Also some tasks could have dangerous side effects if run with un-set variables.
Using requires
you specify an array of strings in the vars
sub-section under requires
, these strings are variable names which are checked prior to running the task. If any variables are un-set the the task will error and not run.
Environmental variables are also checked.
Syntax:
requires:
vars: [] # Array of strings
Variables set to empty zero length strings, will pass the requires
check.
Example of using requires
:
version: '3'
tasks:
docker-build:
cmds:
- 'docker build . -t {{.IMAGE_NAME}}:{{.IMAGE_TAG}}'
# Make sure these variables are set before running
requires:
vars: [IMAGE_NAME, IMAGE_TAG]
変数
When doing interpolation of variables, Task will look for the below. They are listed below in order of importance (i.e. most important first):
- Variables declared in the task definition
- Variables given while calling a task from another (See Calling another task above)
- Variables of the included Taskfile (when the task is included)
- Variables of the inclusion of the Taskfile (when the task is included)
- Global variables (those declared in the
vars:
option in the Taskfile) - Environment variables
Example of sending parameters with environment variables:
$ TASK_VARIABLE=a-value task do-something
A special variable .TASK
is always available containing the task name.
Since some shells do not support the above syntax to set environment variables (Windows) tasks also accept a similar style when not at the beginning of the command.
$ task write-file FILE=file.txt "CONTENT=Hello, World!" print "MESSAGE=All done!"
Example of locally declared vars:
version: '3'
tasks:
print-var:
cmds:
- echo "{{.VAR}}"
vars:
VAR: Hello!
Example of global vars in a Taskfile.yml
:
version: '3'
vars:
GREETING: Hello from Taskfile!
tasks:
greet:
cmds:
- echo "{{.GREETING}}"
Dynamic variables
The below syntax (sh:
prop in a variable) is considered a dynamic variable. The value will be treated as a command and the output assigned. If there are one or more trailing newlines, the last newline will be trimmed.
version: '3'
tasks:
build:
cmds:
- go build -ldflags="-X main.Version={{.GIT_COMMIT}}" main.go
vars:
GIT_COMMIT:
sh: git log -n 1 --format=%h
This works for all types of variables.
Looping over values
As of v3.28.0, Task allows you to loop over certain values and execute a command for each. There are a number of ways to do this depending on the type of value you want to loop over.
Looping over a static list
The simplest kind of loop is an explicit one. This is useful when you want to loop over a set of values that are known ahead of time.
version: '3'
tasks:
default:
cmds:
- for: ['foo.txt', 'bar.txt']
cmd: cat {{ .ITEM }}
Looping over your task's sources
You are also able to loop over the sources of your task:
version: '3'
tasks:
default:
sources:
- foo.txt
- bar.txt
cmds:
- for: sources
cmd: cat {{ .ITEM }}
This will also work if you use globbing syntax in your sources. For example, if you specify a source for *.txt
, the loop will iterate over all files that match that glob.
Source paths will always be returned as paths relative to the task directory. If you need to convert this to an absolute path, you can use the built-in joinPath
function. There are some special variables that you may find useful for this.
version: '3'
tasks:
default:
vars:
MY_DIR: /path/to/dir
dir: '{{.MY_DIR}}'
sources:
- foo.txt
- bar.txt
cmds:
- for: sources
cmd: cat {{joinPath .MY_DIR .ITEM}}
Looping over variables
To loop over the contents of a variable, you simply need to specify the variable you want to loop over. By default, variables will be split on any whitespace characters.
version: '3'
tasks:
default:
vars:
MY_VAR: foo.txt bar.txt
cmds:
- for: { var: MY_VAR }
cmd: cat {{.ITEM}}
If you need to split on a different character, you can do this by specifying the split
property:
version: '3'
tasks:
default:
vars:
MY_VAR: foo.txt,bar.txt
cmds:
- for: { var: MY_VAR, split: ',' }
cmd: cat {{.ITEM}}
All of this also works with dynamic variables!
version: '3'
tasks:
default:
vars:
MY_VAR:
sh: find -type f -name '*.txt'
cmds:
- for: { var: MY_VAR }
cmd: cat {{.ITEM}}
Renaming variables
If you want to rename the iterator variable to make it clearer what the value contains, you can do so by specifying the as
property:
version: '3'
tasks:
default:
vars:
MY_VAR: foo.txt bar.txt
cmds:
- for: { var: MY_VAR, as: FILE }
cmd: cat {{.FILE}}
Looping over tasks
Because the for
property is defined at the cmds
level, you can also use it alongside the task
keyword to run tasks multiple times with different variables.
version: '3'
tasks:
default:
cmds:
- for: [foo, bar]
task: my-task
vars:
FILE: '{{.ITEM}}'
my-task:
cmds:
- echo '{{.FILE}}'
Or if you want to run different tasks depending on the value of the loop:
version: '3'
tasks:
default:
cmds:
- for: [foo, bar]
task: task-{{.ITEM}}
task-foo:
cmds:
- echo 'foo'
task-bar:
cmds:
- echo 'bar'
CLI引数をコマンドにフォワード
CLIで--
が渡されると、次に続く全てのパラメータが、.CLI_ARGS
という特別な変数に追加されます。 これは引数を別のコマンドにフォワードするのに便利です。
以下の例ではyarn install
を実行します。
$ task yarn -- install
version: '3'
tasks:
yarn:
cmds:
- yarn {{.CLI_ARGS}}
defer
を使ったタスクのクリーンアップ
With the defer
keyword, it's possible to schedule cleanup to be run once the task finishes. The difference with just putting it as the last command is that this command will run even when the task fails.
In the example below, rm -rf tmpdir/
will run even if the third command fails:
version: '3'
tasks:
default:
cmds:
- mkdir -p tmpdir/
- defer: rm -rf tmpdir/
- echo 'Do work on tmpdir/'
If you want to move the cleanup command into another task, that is possible as well:
version: '3'
tasks:
default:
cmds:
- mkdir -p tmpdir/
- defer: { task: cleanup }
- echo 'Do work on tmpdir/'
cleanup: rm -rf tmpdir/
Due to the nature of how the Go's own defer
work, the deferred commands are executed in the reverse order if you schedule multiple of them.
Goのテンプレートエンジン
Task parse commands as Go's template engine before executing them. Variables are accessible through dot syntax (.VARNAME
).
All functions by the Go's slim-sprig lib are available. The following example gets the current date in a given format:
version: '3'
tasks:
print-date:
cmds:
- echo {{now | date "2006-01-02"}}
Task also adds the following functions:
OS
: Returns the operating system. Possible values arewindows
,linux
,darwin
(macOS) andfreebsd
.ARCH
: return the architecture Task was compiled to:386
,amd64
,arm
ors390x
.splitLines
: Splits Unix (\n
) and Windows (\r\n
) styled newlines.catLines
: Replaces Unix (\n
) and Windows (\r\n
) styled newlines with a space.toSlash
: Does nothing on Unix, but on Windows converts a string from\
path format to/
.fromSlash
: Opposite oftoSlash
. Does nothing on Unix, but on Windows converts a string from/
path format to\
.exeExt
: Returns the right executable extension for the current OS (".exe"
for Windows,""
for others).shellQuote
: Quotes a string to make it safe for use in shell scripts. Task uses this Go function for this. The Bash dialect is assumed.splitArgs
: Splits a string as if it were a command's arguments. Task uses this Go function
例:
version: '3'
tasks:
print-os:
cmds:
- echo '{{OS}} {{ARCH}}'
- echo '{{if eq OS "windows"}}windows-command{{else}}unix-command{{end}}'
# This will be path/to/file on Unix but path\to\file on Windows
- echo '{{fromSlash "path/to/file"}}'
enumerated-file:
vars:
CONTENT: |
foo
bar
cmds:
- |
cat << EOF > output.txt
{{range $i, $line := .CONTENT | splitLines -}}
{{printf "%3d" $i}}: {{$line}}
{{end}}EOF
ヘルプ
task --list
(またはtask -l
)を実行すると、説明付きで全てのタスクが一覧表示されます。 Taskfileの例:
version: '3'
tasks:
build:
desc: Build the go binary.
cmds:
- go build -v -i main.go
test:
desc: Run all the go tests.
cmds:
- go test -race ./...
js:
cmds:
- esbuild --bundle --minify js/index.js > public/bundle.js
css:
cmds:
- esbuild --bundle --minify css/index.css > public/bundle.css
上記のTaskfileの場合、以下のような出力が表示されます:
* build: Build the go binary.
* test: Run all the go tests.
全てのタスクを見たい場合は、--list-all
(エイリアス -a
)のフラグを使用してください。
タスクの概要を表示する
task --summary task-name
を実行することでタスクの概要が表示されます。 Taskfileの例:
version: '3'
tasks:
release:
deps: [build]
summary: |
Release your project to github
It will build your project before starting the release.
Please make sure that you have set GITHUB_TOKEN before starting.
cmds:
- your-release-tool
build:
cmds:
- your-build-tool
task --summary release
を実行することで、以下のように出力されます:
task: release
Release your project to github
It will build your project before starting the release.
Please make sure that you have set GITHUB_TOKEN before starting.
dependencies:
- build
commands:
- your-release-tool
summaryがない場合はdescriptionが表示されます。 summaryもdescriptionもない場合は警告が表示されます。
注意: 概要を表示するときはコマンドは実行されません。
タスクのエイリアス
Aliases are alternative names for tasks. They can be used to make it easier and quicker to run tasks with long or hard-to-type names. You can use them on the command line, when calling sub-tasks in your Taskfile and when including tasks with aliases from another Taskfile. They can also be used together with namespace aliases.
version: '3'
tasks:
generate:
aliases: [gen]
cmds:
- task: gen-mocks
generate-mocks:
aliases: [gen-mocks]
cmds:
- echo "generating..."
タスク名の上書き
Sometimes you may want to override the task name printed on the summary, up-to-date messages to STDOUT, etc. In this case, you can just set label:
, which can also be interpolated with variables:
version: '3'
tasks:
default:
- task: print
vars:
MESSAGE: hello
- task: print
vars:
MESSAGE: world
print:
label: 'print-{{.MESSAGE}}'
cmds:
- echo "{{.MESSAGE}}"
警告プロンプト
Warning Prompts are used to prompt a user for confirmation before a task is executed.
Below is an example using prompt
with a dangerous command, that is called between two safe commands:
version: '3'
tasks:
example:
cmds:
- task: not-dangerous
- task: dangerous
- task: another-not-dangerous
not-dangerous:
cmds:
- echo 'not dangerous command'
another-not-dangerous:
cmds:
- echo 'another not dangerous command'
dangerous:
prompt: This is a dangerous command... Do you want to continue?
cmds:
- echo 'dangerous command'
❯ task dangerous
task: "This is a dangerous command... Do you want to continue?" [y/N]
Warning prompts are called before executing a task. If a prompt is denied Task will exit with exit code 205. If approved, Task will continue as normal.
❯ task example
not dangerous command
task: "This is a dangerous command. Do you want to continue?" [y/N]
y
dangerous command
another not dangerous command
To skip warning prompts automatically, you can use the --yes
(alias -y
) option when calling the task. By including this option, all warnings, will be automatically confirmed, and no prompts will be shown.
Tasks with prompts always fail by default on non-terminal environments, like a CI, where an stdin
won't be available for the user to answer. In those cases, use --yes
(-y
) to force all tasks with a prompt to run.
サイレントモード
Silent mode disables the echoing of commands before Task runs it. For the following Taskfile:
version: '3'
tasks:
echo:
cmds:
- echo "Print something"
Normally this will be printed:
echo "Print something"
Print something
With silent mode on, the below will be printed instead:
Print something
There are four ways to enable silent mode:
- At command level:
version: '3'
tasks:
echo:
cmds:
- cmd: echo "Print something"
silent: true
- At task level:
version: '3'
tasks:
echo:
cmds:
- echo "Print something"
silent: true
- Globally at Taskfile level:
version: '3'
silent: true
tasks:
echo:
cmds:
- echo "Print something"
- Or globally with
--silent
or-s
flag
If you want to suppress STDOUT instead, just redirect a command to /dev/null
:
version: '3'
tasks:
echo:
cmds:
- echo "This will print nothing" > /dev/null
ドライランモード
ドライランモード(--dry
)は各タスクをコンパイルし、実際にはコマンドの内容は実行せずに、タスク内の各ステップで実行されるコマンドを表示します。 これはTaskfileをデバッグする際に便利です。
エラーを無視する
コマンド実行時のエラーを無視するオプションがあります。 以下のTaskfileを参照してください:
version: '3'
tasks:
echo:
cmds:
- exit 1
- echo "Hello World"
Taskはexit 1
を実行した後、実行が中止されます。なぜならステータスコード1
はEXIT_FAILURE
を意味するためです。 しかしながら、ignore_error
を使用することで、実行を継続させることが可能です:
version: '3'
tasks:
echo:
cmds:
- cmd: exit 1
ignore_error: true
- echo "Hello World"
ignore_error
はタスク全体に対しても設定することができます。つまり、全てのコマンドに対してエラーが抑制されます。 一方でdeps
やcmds
によって呼び出された他のタスクには伝播しないことに注意してください!
出力構文
By default, Task just redirects the STDOUT and STDERR of the running commands to the shell in real-time. This is good for having live feedback for logging printed by commands, but the output can become messy if you have multiple commands running simultaneously and printing lots of stuff.
To make this more customizable, there are currently three different output options you can choose:
interleaved
(default)group
prefixed
To choose another one, just set it to root in the Taskfile:
version: '3'
output: 'group'
tasks:
# ...
The group
output will print the entire output of a command once after it finishes, so you will not have live feedback for commands that take a long time to run.
When using the group
output, you can optionally provide a templated message to print at the start and end of the group. This can be useful for instructing CI systems to group all of the output for a given task, such as with GitHub Actions' ::group::
command or Azure Pipelines.
version: '3'
output:
group:
begin: '::group::{{.TASK}}'
end: '::endgroup::'
tasks:
default:
cmds:
- echo 'Hello, World!'
silent: true
$ task default
::group::default
Hello, World!
::endgroup::
When using the group
output, you may swallow the output of the executed command on standard output and standard error if it does not fail (zero exit code).
version: '3'
silent: true
output:
group:
error_only: true
tasks:
passes: echo 'output-of-passes'
errors: echo 'output-of-errors' && exit 1
$ task passes
$ task errors
output-of-errors
task: Failed to run task "errors": exit status 1
The prefix
output will prefix every line printed by a command with [task-name]
as the prefix, but you can customize the prefix for a command with the prefix:
attribute:
version: '3'
output: prefixed
tasks:
default:
deps:
- task: print
vars: { TEXT: foo }
- task: print
vars: { TEXT: bar }
- task: print
vars: { TEXT: baz }
print:
cmds:
- echo "{{.TEXT}}"
prefix: 'print-{{.TEXT}}'
silent: true
$ task default
[print-foo] foo
[print-bar] bar
[print-baz] baz
The output
option can also be specified by the --output
or -o
flags.
対話型CLIアプリケーション
Task内で対話型CLIアプリケーションを実行する際、時折変な挙動をすることがあり、特に出力モードが交互
(デフォルト)に設定されていない、または対話型アプリが他のタスクと並行して実行される場合に発生します。
interactive: true
は、これが対話型アプリケーションであることをTaskに伝え、Taskはそれに最適化しようとします:
version: '3'
tasks:
default:
cmds:
- vim my-file.txt
interactive: true
対話側アプリをTaskを通して実行する際に依然として問題がある場合は、それについてのIssueを作ってください。
短いタスク構文
Task v3から、デフォルトの設定(例: カスタムな env:
、vars
、desc:
、silent:
などがない場合)を持つタスクは、より短い構文で記述することができます:
version: '3'
tasks:
build: go build -v -o ./app{{exeExt}} .
run:
- task: build
- ./app{{exeExt}} -h localhost -p 8080
set
とshopt
set
およびshopt
の組み込みコマンドにオプションを渡すことが可能です。 これは、グローバル、タスク、またはコマンドのそれぞれのレベルで設定することができます。
version: '3'
set: [pipefail]
shopt: [globstar]
tasks:
# `globstar` required for double star globs to work
default: echo **/*.go
Taskが使用するシェルインタプリタライブラリで利用可能なオプションは全てがあるわけではないことに注意してください。
タスクのウォッチ
With the flags --watch
or -w
task will watch for file changes and run the task again. This requires the sources
attribute to be given, so task knows which files to watch.
The default watch interval is 5 seconds, but it's possible to change it by either setting interval: '500ms'
in the root of the Taskfile passing it as an argument like --interval=500ms
.
Also, it's possible to set watch: true
in a given task and it'll automatically run in watch mode:
version: '3'
interval: 500ms
tasks:
build:
desc: Builds the Go application
watch: true
sources:
- '**/*.go'
cmds:
- go build # ...
Note that when setting watch: true
to a task, it'll only run in watch mode when running from the CLI via task my-watch-task
, but won't run in watch mode if called by another task, either directly or as a dependency.