mirror of
https://github.com/go-task/task.git
synced 2024-12-14 10:52:43 +02:00
74f5cf8f29
Fixes #647 This allows CI systems that support grouping (such as with [GitHub Actions's `::group::` command](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines) and [Azure Devops](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?view=azure-devops&tabs=bash#formatting-commands)) to collapse all of the logs for a single task, to improve readability of logs ## Example The following Taskfile ``` # Taskfile.yml version: 3 output: group: begin: "::group::{{ .TASK }}" end: "::endgroup::" tasks: default: cmds: - "echo 'Hello, World!'" ``` Results in the following output ```bash $ task task: [default] echo 'Hello, World!' ::group::default Hello, World! ::endgroup:: ``` See [this GitHub Actions job](https://github.com/janslow/task/runs/4811059609?check_suite_focus=true) for a full example <img width="771" alt="image" src="https://user-images.githubusercontent.com/1253367/149429832-6cb0c1b5-0758-442e-9375-c4daa65771bc.png"> <img width="394" alt="image" src="https://user-images.githubusercontent.com/1253367/149429851-1d5d2ab5-9095-4795-9b57-f91750720d40.png"> |
||
|---|---|---|
| .. | ||
| _sidebar.md | ||
| .nojekyll | ||
| CNAME | ||
| community.md | ||
| donate.md | ||
| favicon.ico | ||
| index.html | ||
| install.sh | ||
| installation.md | ||
| Logo.png | ||
| pix.png | ||
| README.md | ||
| releasing_task.md | ||
| styleguide.md | ||
| taskfile_versions.md | ||
| Taskfile.yml | ||
| usage.md | ||
Task
Task is a task runner / build tool that aims to be simpler and easier to use than, for example, GNU Make.
Since it's written in Go, Task is just a single binary and has no other dependencies, which means you don't need to mess with any complicated install setups just to use a build tool.
Once installed, you just need to describe your build tasks
using a simple YAML schema in a file called Taskfile.yml:
version: '3'
tasks:
hello:
cmds:
- echo 'Hello World from Task!'
silent: true
And call it by running task hello from you terminal.
The above example is just the start, you can take a look at the usage guide to check the full schema documentation and Task features.
Features
- Easy installation: just download a single binary, add to $PATH and you're done! Or you can also install using Homebrew, Snapcraft, or Scoop if you want;
- Available on CIs: by adding this simple command to install on your CI script and you're done to use Task as part of your CI pipeline;
- Truly cross-platform: while most build tools only work well on Linux or macOS, Task also supports Windows thanks to this awesome shell interpreter for Go;
- Great for code generation: you can easily prevent a task from running if a given set of files haven't changed since last run (based either on its timestamp or content).