81e0f170ef
One test is not yet migrated. First we should have specific Stdin, Stdout and Stderr for executor. |
||
---|---|---|
cmd/task | ||
example | ||
execext | ||
testdata | ||
vendor | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.travis.yml | ||
cyclic_test.go | ||
cyclic.go | ||
errors.go | ||
file.go | ||
Gopkg.lock | ||
Gopkg.toml | ||
goreleaser.yml | ||
help.go | ||
init.go | ||
LICENSE | ||
read_taskfile.go | ||
README.md | ||
task_test.go | ||
task.go | ||
Taskfile.yml | ||
variable_handling.go | ||
watch.go |
Task - Simple task runner / "Make" alternative
Task is a simple tool that allows you to easily run development and build tasks. Task is written in Golang, but can be used to develop any language. It aims to be simpler and easier to use then GNU Make.
Installation
If you have a Golang environment setup, you can simply run:
go get -u -v github.com/go-task/task/cmd/task
Or you can download the binary from the releases page and add to
your PATH
. DEB and RPM packages are also available.
Usage
Create a file called Taskfile.yml
in the root of the project.
(Taskfile.toml
and Taskfile.json
are also supported, but YAML is used in
the documentation). The cmds
attribute should contains the commands of a
task:
build:
cmds:
- go build -v -i main.go
assets:
cmds:
- gulp
Running the tasks is as simple as running:
task assets build
Task uses github.com/mvdan/sh, a native Go sh
interpreter. So you can write sh/bash commands and it will work even on
Windows, where sh
or bash
is usually not available. Just remember any
executable called must be available by the OS or in PATH.
If you ommit a task name, "default" will be assumed.
Environment
You can specify environment variables that are added when running a command:
build:
cmds:
- echo $hallo
env:
hallo: welt
OS specific task support
If you add a Taskfile_{{GOOS}}
you can override or amend your taskfile based
on the operating system.
Example:
Taskfile.yml:
build:
cmds:
- echo "default"
Taskfile_linux.yml:
build:
cmds:
- echo "linux"
Will print out linux
and not default
Running task in another dir
By default, tasks will be executed in the directory where the Taskfile is
located. But you can easily make the task run in another folder informing
dir
:
js:
dir: www/public/js
cmds:
- gulp
Task dependencies
You may have tasks that depends on others. Just pointing them on deps
will
make them run automatically before running the parent task:
build:
deps: [assets]
cmds:
- go build -v -i main.go
assets:
cmds:
- gulp
In the above example, assets
will always run right before build
if you run
task build
.
A task can have only dependencies and no commands to group tasks together:
assets:
deps: [js, css]
js:
cmds:
- npm run buildjs
css:
cmds:
- npm run buildcss
Each task can only be run once. If it is included from another dependend task causing a cyclomatic dependency, execution will be stopped.
task1:
deps: [task2]
task2:
deps: [task1]
Will stop at the moment the dependencies of task2
are executed.
Calling a task from another task
When a task has many dependencies, they are executed concurrently. This will
often result in a faster build pipeline. But in some situations you may need
to call other tasks serially. For this just prefix a command with ^
:
a-task:
cmds:
- ^another-task
- ^even-another-task
- echo "Both done"
another-task:
cmds:
- ...
even-another-task:
cmds:
- ...
Prevent task from running when not necessary
If a task generates something, you can inform Task the source and generated files, so Task will prevent to run them if not necessary.
build:
deps: [js, css]
cmds:
- go build -v -i main.go
js:
cmds:
- npm run buildjs
sources:
- js/src/**/*.js
generates:
- public/bundle.js
css:
cmds:
- npm run buildcss
sources:
- css/src/*.css
generates:
- public/bundle.css
sources
and generates
should be file patterns. When both are given, Task
will compare the modification date/time of the files to determine if it's
necessary to run the task. If not, it will just print
Task "js" 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:
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
You can use --force
or -f
if you want to force a task to run even when
up-to-date.
Variables
build:
deps: [setvar]
cmds:
- echo "{{.PREFIX}} {{.THEVAR}}"
vars:
PREFIX: "Path:"
setvar:
cmds:
- echo "{{.PATH}}"
set: THEVAR
The above sample saves the path into a new variable which is then again echoed.
You can use environment variables, task level variables and a file called
Taskvars.yml
(or Taskvars.toml
or Taskvars.json
) as source of variables.
They are evaluated in the following order:
Task local variables are overwritten by variables found in Taskvars
file.
Variables found in Taskvars
file are overwritten with variables from the
environment. The output of the last command is stored in the environment. So
you can do something like this:
build:
deps: [setvar]
cmds:
- echo "{{.PREFIX}} '{{.THEVAR}}'"
vars:
PREFIX: "Result: "
setvar:
cmds:
- echo -n "a"
- echo -n "{{.THEVAR}}b"
- echo -n "{{.THEVAR}}c"
set: THEVAR
The result of a run of build would be:
a
ab
abc
Result: 'abc'
Dynamic variables
If you prefix a variable with $
, then the variable is considered a dynamic
variable. The value after the $-symbol will be treated as a command and the
output assigned.
build:
cmds:
- go build -ldflags="-X main.Version={{.LAST_GIT_COMMIT}}" main.go
vars:
LAST_GIT_COMMIT: $git log -n 1 --format=%h
Go's template engine
Task parse commands as Go's template engine before executing
them. Variables are acessible through dot syntax (.VARNAME
).
All functions by the Go's sprig lib are available. The following example gets the current date in a given format:
print-date:
cmds:
- echo {{now | date "2006-01-02"}}
Task also adds the following functions:
OS
: Returns operating system. Possible values are "windows", "linux", "darwin" (macOS) and "freebsd".ARCH
: return the architecture Task was compiled to: "386", "amd64", "arm" or "s390x".ToSlash
: Does nothing on Unix, but on Windows converts a string from\
path format to/
.FromSlash
: Oposite 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).
Example:
printos:
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
- "{{FromSlash \"path/to/file\"}}"
Help
Running task help
lists all tasks with a description. The following taskfile:
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:
- npm run buildjs
css:
cmds:
- npm run buildcss
would print the following output:
build Build the go binary.
test Run all the go tests.
Watch tasks (experimental)
If you give a --watch
or -w
argument, task will watch for files changes
and run the task again. This requires the sources
attribute to be given,
so task know which files to watch.
Alternative task runners
- YAML based:
- Go based: