diff --git a/404.html b/404.html index 0c5cb29a..a8390594 100644 --- a/404.html +++ b/404.html @@ -10,13 +10,13 @@ - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/api/index.html b/api/index.html index 155277f0..bde23709 100644 --- a/api/index.html +++ b/api/index.html @@ -10,7 +10,7 @@ - + @@ -20,7 +20,7 @@ variable

ShortFlagTypecmds and everything else will be set to their default values:

tasks:
  foo: echo "foo"

  foobar:
    - echo "foo"
    - echo "bar"

  baz:
    cmd: echo "baz"

Command​

AttributeTypeDefaultDescription
cmdstringThe shell command to be executed.
silentboolfalseSkips some output for this command. Note that STDOUT and STDERR of the commands will still be redirected.
taskstringSet this to trigger execution of another task instead of running a command. This cannot be set together with cmd.
varsmap[string]VariableOptional additional variables to be passed to the referenced task. Only relevant when setting task instead of cmd.
ignore_errorboolfalseContinue execution if errors happen while executing the command.
deferstringAlternative to cmd, but schedules the command to be executed at the end of this task instead of immediately. This cannot be used together with cmd.
platforms[]stringAll platformsSpecifies which platforms the command should be run on. Valid GOOS and GOARCH values allowed. Command will be skipped otherwise.
set[]stringSpecify options for the set builtin.
shopt[]stringSpecify option for the shopt builtin.
info

If given as a a string, the value will be assigned to cmd:

tasks:
  foo:
    cmds:
      - echo "foo"
      - echo "bar"

Dependency​

AttributeTypeDefaultDescription
taskstringThe task to be execute as a dependency.
varsmap[string]VariableOptional additional variables to be passed to this task.
tip

If you don't want to set additional variables, it's enough to declare the dependency as a list of strings (they will be assigned to task):

tasks:
  foo:
    deps: [foo, bar]

Precondition​

AttributeTypeDefaultDescription
shstringCommand to be executed. If a non-zero exit code is returned, the task errors without executing its commands.
msgstringOptional message to print if the precondition isn't met.
tip

If you don't want to set a different message, you can declare a precondition like this and the value will be assigned to sh:

tasks:
  foo:
    precondition: test -f Taskfile.yml
- + \ No newline at end of file diff --git a/assets/js/935f2afb.3c598d09.js b/assets/js/935f2afb.8872dd05.js similarity index 98% rename from assets/js/935f2afb.3c598d09.js rename to assets/js/935f2afb.8872dd05.js index 9deb2969..20b21e8a 100644 --- a/assets/js/935f2afb.3c598d09.js +++ b/assets/js/935f2afb.8872dd05.js @@ -1 +1 @@ -"use strict";(self.webpackChunktaskfile_dev=self.webpackChunktaskfile_dev||[]).push([[53],{1109:function(e){e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Home","href":"/","docId":"intro"},{"type":"link","label":"Installation","href":"/installation/","docId":"installation"},{"type":"link","label":"Usage","href":"/usage/","docId":"usage"},{"type":"link","label":"API Reference","href":"/api/","docId":"api_reference"},{"type":"link","label":"FAQ","href":"/faq/","docId":"faq"},{"type":"link","label":"Styleguide","href":"/styleguide/","docId":"styleguide"},{"type":"link","label":"Changelog","href":"/changelog/","docId":"changelog"},{"type":"link","label":"Community","href":"/community/","docId":"community"},{"type":"link","label":"Contributing","href":"/contributing/","docId":"contributing"},{"type":"link","label":"Releasing","href":"/releasing/","docId":"releasing"},{"type":"link","label":"Taskfile Versions","href":"/taskfile-versions/","docId":"taskfile_versions"},{"type":"link","label":"Donate","href":"/donate/","docId":"donate"},{"type":"link","label":"Translate","href":"/translate/","docId":"translate"},{"type":"link","label":"Chinese | \u4e2d\u56fd\u4eba","href":"https://task-zh.readthedocs.io/zh_CN/latest/"}]},"docs":{"api_reference":{"id":"api_reference","title":"API Reference","description":"CLI","sidebar":"tutorialSidebar"},"changelog":{"id":"changelog","title":"Changelog","description":"v3.22.0 - 2023-03-10","sidebar":"tutorialSidebar"},"community":{"id":"community","title":"Community","description":"Some of the work to improve the Task ecosystem is done by the community, be","sidebar":"tutorialSidebar"},"contributing":{"id":"contributing","title":"Contributing","description":"Contributions to Task are very welcome, but we ask that you read this document","sidebar":"tutorialSidebar"},"donate":{"id":"donate","title":"Donate","description":"If you find this project useful, you can consider donating by using one of the","sidebar":"tutorialSidebar"},"faq":{"id":"faq","title":"FAQ","description":"This page contains a list of frequently asked questions about Task.","sidebar":"tutorialSidebar"},"installation":{"id":"installation","title":"Installation","description":"Task offers many installation methods. Check out the available methods below.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Home","description":"Task is a task runner / build tool that aims to be simpler and easier to use","sidebar":"tutorialSidebar"},"releasing":{"id":"releasing","title":"Releasing","description":"The release process of Task is done with the help of","sidebar":"tutorialSidebar"},"styleguide":{"id":"styleguide","title":"Styleguide","description":"This is the official Task styleguide for Taskfile.yml files. This guide","sidebar":"tutorialSidebar"},"taskfile_versions":{"id":"taskfile_versions","title":"Taskfile Versions","description":"The Taskfile syntax and features changed with time. This document explains what","sidebar":"tutorialSidebar"},"translate":{"id":"translate","title":"Translate","description":"Want to help us translate this documentation? In this document we explain how.","sidebar":"tutorialSidebar"},"usage":{"id":"usage","title":"Usage","description":"Getting started","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunktaskfile_dev=self.webpackChunktaskfile_dev||[]).push([[53],{1109:function(e){e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Home","href":"/","docId":"intro"},{"type":"link","label":"Installation","href":"/installation/","docId":"installation"},{"type":"link","label":"Usage","href":"/usage/","docId":"usage"},{"type":"link","label":"API Reference","href":"/api/","docId":"api_reference"},{"type":"link","label":"FAQ","href":"/faq/","docId":"faq"},{"type":"link","label":"Styleguide","href":"/styleguide/","docId":"styleguide"},{"type":"link","label":"Changelog","href":"/changelog/","docId":"changelog"},{"type":"link","label":"Community","href":"/community/","docId":"community"},{"type":"link","label":"Contributing","href":"/contributing/","docId":"contributing"},{"type":"link","label":"Releasing","href":"/releasing/","docId":"releasing"},{"type":"link","label":"Taskfile Versions","href":"/taskfile-versions/","docId":"taskfile_versions"},{"type":"link","label":"Donate","href":"/donate/","docId":"donate"},{"type":"link","label":"Translate","href":"/translate/","docId":"translate"},{"type":"link","label":"Chinese | \u4e2d\u56fd\u4eba","href":"https://task-zh.readthedocs.io/zh_CN/latest/"}]},"docs":{"api_reference":{"id":"api_reference","title":"API Reference","description":"CLI","sidebar":"tutorialSidebar"},"changelog":{"id":"changelog","title":"Changelog","description":"v3.23.0 - 2023-03-26","sidebar":"tutorialSidebar"},"community":{"id":"community","title":"Community","description":"Some of the work to improve the Task ecosystem is done by the community, be","sidebar":"tutorialSidebar"},"contributing":{"id":"contributing","title":"Contributing","description":"Contributions to Task are very welcome, but we ask that you read this document","sidebar":"tutorialSidebar"},"donate":{"id":"donate","title":"Donate","description":"If you find this project useful, you can consider donating by using one of the","sidebar":"tutorialSidebar"},"faq":{"id":"faq","title":"FAQ","description":"This page contains a list of frequently asked questions about Task.","sidebar":"tutorialSidebar"},"installation":{"id":"installation","title":"Installation","description":"Task offers many installation methods. Check out the available methods below.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Home","description":"Task is a task runner / build tool that aims to be simpler and easier to use","sidebar":"tutorialSidebar"},"releasing":{"id":"releasing","title":"Releasing","description":"The release process of Task is done with the help of","sidebar":"tutorialSidebar"},"styleguide":{"id":"styleguide","title":"Styleguide","description":"This is the official Task styleguide for Taskfile.yml files. This guide","sidebar":"tutorialSidebar"},"taskfile_versions":{"id":"taskfile_versions","title":"Taskfile Versions","description":"The Taskfile syntax and features changed with time. This document explains what","sidebar":"tutorialSidebar"},"translate":{"id":"translate","title":"Translate","description":"Want to help us translate this documentation? In this document we explain how.","sidebar":"tutorialSidebar"},"usage":{"id":"usage","title":"Usage","description":"Getting started","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/9beb87c2.ae7d3c47.js b/assets/js/9beb87c2.ae7d3c47.js new file mode 100644 index 00000000..9655334c --- /dev/null +++ b/assets/js/9beb87c2.ae7d3c47.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktaskfile_dev=self.webpackChunktaskfile_dev||[]).push([[34],{3905:function(t,e,a){a.d(e,{Zo:function(){return h},kt:function(){return d}});var i=a(7294);function s(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function n(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(t);e&&(i=i.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,i)}return a}function l(t){for(var e=1;e=0||(s[a]=t[a]);return s}(t,e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(s[a]=t[a])}return s}var o=i.createContext({}),k=function(t){var e=i.useContext(o),a=e;return t&&(a="function"==typeof t?t(e):l(l({},e),t)),a},h=function(t){var e=k(t.components);return i.createElement(o.Provider,{value:e},t.children)},m="mdxType",p={inlineCode:"code",wrapper:function(t){var e=t.children;return i.createElement(i.Fragment,{},e)}},u=i.forwardRef((function(t,e){var a=t.components,s=t.mdxType,n=t.originalType,o=t.parentName,h=r(t,["components","mdxType","originalType","parentName"]),m=k(a),u=s,d=m["".concat(o,".").concat(u)]||m[u]||p[u]||n;return a?i.createElement(d,l(l({ref:e},h),{},{components:a})):i.createElement(d,l({ref:e},h))}));function d(t,e){var a=arguments,s=e&&e.mdxType;if("string"==typeof t||s){var n=a.length,l=new Array(n);l[0]=u;var r={};for(var o in e)hasOwnProperty.call(e,o)&&(r[o]=e[o]);r.originalType=t,r[m]="string"==typeof t?t:s,l[1]=r;for(var k=2;k=0||(s[a]=t[a]);return s}(t,e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(s[a]=t[a])}return s}var o=i.createContext({}),k=function(t){var e=i.useContext(o),a=e;return t&&(a="function"==typeof t?t(e):l(l({},e),t)),a},h=function(t){var e=k(t.components);return i.createElement(o.Provider,{value:e},t.children)},m="mdxType",u={inlineCode:"code",wrapper:function(t){var e=t.children;return i.createElement(i.Fragment,{},e)}},p=i.forwardRef((function(t,e){var a=t.components,s=t.mdxType,n=t.originalType,o=t.parentName,h=r(t,["components","mdxType","originalType","parentName"]),m=k(a),p=s,d=m["".concat(o,".").concat(p)]||m[p]||u[p]||n;return a?i.createElement(d,l(l({ref:e},h),{},{components:a})):i.createElement(d,l({ref:e},h))}));function d(t,e){var a=arguments,s=e&&e.mdxType;if("string"==typeof t||s){var n=a.length,l=new Array(n);l[0]=p;var r={};for(var o in e)hasOwnProperty.call(e,o)&&(r[o]=e[o]);r.originalType=t,r[m]="string"==typeof t?t:s,l[1]=r;for(var k=2;k=o)&&Object.keys(i.O).every((function(e){return i.O[e](n[a])}))?n.splice(a--,1):(u=!1,o0&&e[d-1][2]>o;d--)e[d]=e[d-1];e[d]=[n,r,o]},i.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return i.d(t,{a:t}),t},n=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},i.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);i.r(o);var f={};t=t||[null,n({}),n([]),n(n)];for(var u=2&r&&e;"object"==typeof u&&!~t.indexOf(u);u=n(u))Object.getOwnPropertyNames(u).forEach((function(t){f[t]=function(){return e[t]}}));return f.default=function(){return e},i.d(o,f),o},i.d=function(e,t){for(var n in t)i.o(t,n)&&!i.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},i.f={},i.e=function(e){return Promise.all(Object.keys(i.f).reduce((function(t,n){return i.f[n](e,t),t}),[]))},i.u=function(e){return"assets/js/"+({34:"9beb87c2",53:"935f2afb",80:"4d54d076",133:"f1d66b0d",217:"3b8c55ea",252:"02371786",514:"1be78505",552:"0afd354a",582:"f7fd502c",595:"d0766b26",648:"3c140c84",671:"0e384e19",705:"7d415946",713:"1c56b476",827:"6476eba6",836:"0480b142",880:"5ef0e9d6",918:"17896441",920:"1a4e3797"}[e]||e)+"."+{34:"eed46a08",53:"3c598d09",80:"5e69e92c",133:"6862b446",217:"54339141",252:"2e4dab92",514:"9062895a",552:"e8bad103",582:"91900bbc",595:"c5627647",648:"b629b889",671:"649e4736",705:"6bf3701e",713:"63036b78",780:"b979b06f",827:"af576646",836:"098568bb",880:"9579102c",894:"4bf7d380",918:"e75765f6",920:"a9132d06",945:"3694633c",972:"01a5a892"}[e]+".js"},i.miniCssF=function(e){},i.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),i.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r={},o="taskfile-dev:",i.l=function(e,t,n,f){if(r[e])r[e].push(t);else{var u,a;if(void 0!==n)for(var c=document.getElementsByTagName("script"),d=0;d=o)&&Object.keys(i.O).every((function(e){return i.O[e](n[a])}))?n.splice(a--,1):(u=!1,o0&&e[d-1][2]>o;d--)e[d]=e[d-1];e[d]=[n,r,o]},i.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return i.d(t,{a:t}),t},n=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},i.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);i.r(o);var f={};t=t||[null,n({}),n([]),n(n)];for(var u=2&r&&e;"object"==typeof u&&!~t.indexOf(u);u=n(u))Object.getOwnPropertyNames(u).forEach((function(t){f[t]=function(){return e[t]}}));return f.default=function(){return e},i.d(o,f),o},i.d=function(e,t){for(var n in t)i.o(t,n)&&!i.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},i.f={},i.e=function(e){return Promise.all(Object.keys(i.f).reduce((function(t,n){return i.f[n](e,t),t}),[]))},i.u=function(e){return"assets/js/"+({34:"9beb87c2",53:"935f2afb",80:"4d54d076",133:"f1d66b0d",217:"3b8c55ea",252:"02371786",514:"1be78505",552:"0afd354a",582:"f7fd502c",595:"d0766b26",648:"3c140c84",671:"0e384e19",705:"7d415946",713:"1c56b476",827:"6476eba6",836:"0480b142",880:"5ef0e9d6",918:"17896441",920:"1a4e3797"}[e]||e)+"."+{34:"ae7d3c47",53:"8872dd05",80:"5e69e92c",133:"6862b446",217:"54339141",252:"2e4dab92",514:"9062895a",552:"e8bad103",582:"91900bbc",595:"c5627647",648:"b629b889",671:"649e4736",705:"6bf3701e",713:"63036b78",780:"b979b06f",827:"af576646",836:"098568bb",880:"9579102c",894:"4bf7d380",918:"e75765f6",920:"a9132d06",945:"3694633c",972:"01a5a892"}[e]+".js"},i.miniCssF=function(e){},i.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),i.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r={},o="taskfile-dev:",i.l=function(e,t,n,f){if(r[e])r[e].push(t);else{var u,a;if(void 0!==n)for(var c=document.getElementsByTagName("script"),d=0;d -Changelog | Task +Changelog | Task - +
-

Changelog

v3.22.0 - 2023-03-10​

- +cancelled, if one returned an error)

v1.2.0 - 2017-04-02​

  • More tests and Travis integration
  • Watch a task (experimental)
  • Possibility to call another task
  • Fix "=" not being reconized in variables/environment variables
  • Tasks can now have a description, and help will print them (#10)
  • Task dependencies now run concurrently
  • Support for a default task (#16)

v1.1.0 - 2017-03-08​

  • Support for YAML, TOML and JSON (#1)
  • Support running command in another directory (#4)
  • --force or -f flag to force execution of task even when it's up-to-date
  • Detection of cyclic dependencies (#5)
  • Support for variables (#6, #9, #14)
  • Operation System specific commands and variables (#13)

v1.0.0 - 2017-02-28​

  • Add LICENSE file
+ \ No newline at end of file diff --git a/community/index.html b/community/index.html index d4028a17..ae28c861 100644 --- a/community/index.html +++ b/community/index.html @@ -10,7 +10,7 @@ - + @@ -39,7 +39,7 @@ by reported bugs and answered questions.

If you know something that is missing in this document, please submit a pull request.

- + \ No newline at end of file diff --git a/contributing/index.html b/contributing/index.html index 19ba17e6..17d7be33 100644 --- a/contributing/index.html +++ b/contributing/index.html @@ -10,7 +10,7 @@ - + @@ -62,7 +62,7 @@ simpler issues that are ideal for first time contributions.

All kinds of c feature. You can also contribute by upvoting/commenting on issues, helping to answer questions or contributing to other community projects.

I'm stuck, where can I get help?

If you have questions, feel free to ask them in the #help forum channel on our Discord server or open a Discussion on GitHub.

- + \ No newline at end of file diff --git a/donate/index.html b/donate/index.html index d56231b9..c1ff26ee 100644 --- a/donate/index.html +++ b/donate/index.html @@ -10,7 +10,7 @@ - + @@ -24,7 +24,7 @@ Suspect businesses (gambling, casinos, etc) won't be allowed, though.

Open Collective​

If you prefer Open Collective you can donate by using these links:

PayPal​

You can donate to @andreynering via PayPal as well:

PIX (Brazil only)​

And if you're Brazilian, you can also donate to @andreynering via PIX by using this QR Code.

- + \ No newline at end of file diff --git a/faq/index.html b/faq/index.html index d6bb138d..c419e933 100644 --- a/faq/index.html +++ b/faq/index.html @@ -10,7 +10,7 @@ - + @@ -27,7 +27,7 @@ around this limitation using one of the following methods:

  • Use the
  • Use a shell on Windows that supports these commands as builtins, such as Git Bash or WSL.

We want to make improvements to this part of Task and the issues below track this work. Constructive comments and contributions are very welcome!

- + \ No newline at end of file diff --git a/index.html b/index.html index 3758c586..06649b69 100644 --- a/index.html +++ b/index.html @@ -10,7 +10,7 @@ - + @@ -27,7 +27,7 @@ to install on your CI script and you're ready to use Task as part of your C Task also supports Windows thanks to this 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).

    • Gold Sponsors​

    Appwrite
    Appwrite
    - + \ No newline at end of file diff --git a/installation/index.html b/installation/index.html index 0856d3ea..68fd86a1 100644 --- a/installation/index.html +++ b/installation/index.html @@ -10,7 +10,7 @@ - + @@ -45,7 +45,7 @@ by the Arduino team:

    go.mod file.

    You can then install the latest release globally by running:

    go install github.com/go-task/task/v3/cmd/task@latest

    Or you can install into another directory:

    env GOBIN=/bin go install github.com/go-task/task/v3/cmd/task@latest
    tip

    For CI environments we recommend using the install script instead, which is faster and more stable, since it'll just download the latest released binary.

    Setup completions​

    Download the autocompletion file corresponding to your shell.

    All completions are available on the Task repository.

    Bash​

    First, ensure that you installed bash-completion using your package manager.

    Make the completion file executable:

    chmod +x path/to/task.bash

    After, add this to your ~/.bash_profile:

    source path/to/task.bash

    ZSH​

    Put the _task file somewhere in your $FPATH:

    mv path/to/_task /usr/local/share/zsh/site-functions/_task

    Ensure that the following is present in your ~/.zshrc:

    autoload -U compinit
    compinit -i

    ZSH version 5.7 or later is recommended.

    Fish​

    Move the task.fish completion script:

    mv path/to/task.fish ~/.config/fish/completions/task.fish

    PowerShell​

    Open your profile script with:

    mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue
    notepad $profile

    Add the line and save the file:

    Invoke-Expression -Command path/to/task.ps1
    - + \ No newline at end of file diff --git a/releasing/index.html b/releasing/index.html index 6ba91748..80bd41a2 100644 --- a/releasing/index.html +++ b/releasing/index.html @@ -10,7 +10,7 @@ - + @@ -33,7 +33,7 @@ If you think its Task version is outdated, open an issue to let us know.

    of updating versions there by editing this file. If you think its Task version is outdated, open an issue to let us know.

    - + \ No newline at end of file diff --git a/search/index.html b/search/index.html index 2712c5da..359aefbf 100644 --- a/search/index.html +++ b/search/index.html @@ -10,13 +10,13 @@ - +

    Search the documentation

    - + \ No newline at end of file diff --git a/styleguide/index.html b/styleguide/index.html index 202faded..d621e710 100644 --- a/styleguide/index.html +++ b/styleguide/index.html @@ -10,7 +10,7 @@ - + @@ -23,7 +23,7 @@ need or want to. Also, feel free to open issues or pull requests with improvements to this guide.

    Use Taskfile.yml and not taskfile.yml​

    # bad
    taskfile.yml


    # good
    Taskfile.yml

    This is important especially for Linux users. Windows and macOS have case insensitive filesystems, so taskfile.yml will end up working, even that not officially supported. On Linux, only Taskfile.yml will work, though.

    Use the correct order of keywords​

    • version:
    • includes:
    • Configuration ones, like output:, silent:, method: and run:
    • vars:
    • env:, dotenv:
    • tasks:

    Use 2 spaces for indentation​

    This is the most common convention for YAML files, and Task follows it.

    # bad
    tasks:
        foo:
            cmds:
                - echo 'foo'


    # good
    tasks:
      foo:
        cmds:
          - echo 'foo'

    Separate with spaces the mains sections​

    # bad
    version: '3'
    includes:
      docker: ./docker/Taskfile.yml
    output: prefixed
    vars:
      FOO: bar
    env:
      BAR: baz
    tasks:
      # ...


    # good
    version: '3'

    includes:
      docker: ./docker/Taskfile.yml

    output: prefixed

    vars:
      FOO: bar

    env:
      BAR: baz

    tasks:
      # ...

    Add spaces between tasks​

    # bad
    version: '3'

    tasks:
      foo:
        cmds:
          - echo 'foo'
      bar:
        cmds:
          - echo 'bar'
      baz:
        cmds:
          - echo 'baz'


    # good
    version: '3'

    tasks:
      foo:
        cmds:
          - echo 'foo'

      bar:
        cmds:
          - echo 'bar'

      baz:
        cmds:
          - echo 'baz'

    Use upper-case variable names​

    # bad
    version: '3'

    vars:
      binary_name: myapp

    tasks:
      build:
        cmds:
          - go build -o {{.binary_name}} .


    # good
    version: '3'

    vars:
      BINARY_NAME: myapp

    tasks:
      build:
        cmds:
          - go build -o {{.BINARY_NAME}} .

    Don't wrap vars in spaces when templating​

    # bad
    version: '3'

    tasks:
      greet:
        cmds:
          - echo '{{ .MESSAGE }}'


    # good
    version: '3'

    tasks:
      greet:
        cmds:
          - echo '{{.MESSAGE}}'

    This convention is also used by most people for any Go templating.

    Separate task name words with a dash​

    # bad
    version: '3'

    tasks:
      do_something_fancy:
        cmds:
          - echo 'Do something'


    # good
    version: '3'

    tasks:
      do-something-fancy:
        cmds:
          - echo 'Do something'

    Use colon for task namespacing​

    # good
    version: '3'

    tasks:
      docker:build:
        cmds:
          - docker ...

      docker:run:
        cmds:
          - docker-compose ...

    This is also done automatically when using included Taskfiles.

    - + \ No newline at end of file diff --git a/taskfile-versions/index.html b/taskfile-versions/index.html index baac8d53..f0702b3e 100644 --- a/taskfile-versions/index.html +++ b/taskfile-versions/index.html @@ -10,7 +10,7 @@ - + @@ -38,7 +38,7 @@ included Taskfile will run:
    - + \ No newline at end of file diff --git a/translate/index.html b/translate/index.html index e6ed1a01..e759dfe2 100644 --- a/translate/index.html +++ b/translate/index.html @@ -10,7 +10,7 @@ - + @@ -22,7 +22,7 @@ translations, please ask for access on the #translations channel on our Discord server. If a given language is not being shown to Crowdin yet, just ask and we can configure it.

    - + \ No newline at end of file diff --git a/usage/index.html b/usage/index.html index 3668e313..20c97bb1 100644 --- a/usage/index.html +++ b/usage/index.html @@ -10,7 +10,7 @@ - + @@ -204,7 +204,7 @@ and run the task again. This requires the sources attribute to be g 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.

    - + \ No newline at end of file