From 4818c9910ca3648720f069799f9f4182e271e4c5 Mon Sep 17 00:00:00 2001 From: task-bot <106601941+task-bot@users.noreply.github.com> Date: Sat, 15 Apr 2023 21:03:39 +0000 Subject: [PATCH] deploy: 5a361f78456e2cb58b18dde9e32f0b4d0c45b20d --- 404.html | 4 +- api/index.html | 4 +- ...f2afb.9bf38336.js => 935f2afb.3a2d6a88.js} | 2 +- assets/js/9beb87c2.633fe3d7.js | 1 - assets/js/9beb87c2.e02982e1.js | 1 + ...n.1f4c1dda.js => runtime~main.e969ad4f.js} | 2 +- changelog/index.html | 151 ++++++++++-------- community/index.html | 4 +- contributing/index.html | 4 +- donate/index.html | 4 +- faq/index.html | 4 +- index.html | 4 +- installation/index.html | 4 +- releasing/index.html | 4 +- search/index.html | 4 +- styleguide/index.html | 4 +- taskfile-versions/index.html | 4 +- translate/index.html | 4 +- usage/index.html | 4 +- 19 files changed, 113 insertions(+), 100 deletions(-) rename assets/js/{935f2afb.9bf38336.js => 935f2afb.3a2d6a88.js} (98%) delete mode 100644 assets/js/9beb87c2.633fe3d7.js create mode 100644 assets/js/9beb87c2.e02982e1.js rename assets/js/{runtime~main.1f4c1dda.js => runtime~main.e969ad4f.js} (98%) diff --git a/404.html b/404.html index 457acdbd..5626c083 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 a9e3620f..66dd2fd8 100644 --- a/api/index.html +++ b/api/index.html @@ -10,7 +10,7 @@ - + @@ -23,7 +23,7 @@ structure:

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.9bf38336.js b/assets/js/935f2afb.3a2d6a88.js similarity index 98% rename from assets/js/935f2afb.9bf38336.js rename to assets/js/935f2afb.3a2d6a88.js index ef5c4412..9438597d 100644 --- a/assets/js/935f2afb.9bf38336.js +++ b/assets/js/935f2afb.3a2d6a88.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.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 it","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 GoReleaser.","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.24.0 - 2023-04-15","sidebar":"tutorialSidebar"},"community":{"id":"community","title":"Community","description":"Some of the work to improve the Task ecosystem is done by the community, be it","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 GoReleaser.","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.633fe3d7.js b/assets/js/9beb87c2.633fe3d7.js deleted file mode 100644 index 3141a1c8..00000000 --- a/assets/js/9beb87c2.633fe3d7.js +++ /dev/null @@ -1 +0,0 @@ -"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",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=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:"633fe3d7",53:"9bf38336",80:"883076b5",133:"6862b446",217:"54a24181",252:"9481901e",514:"9062895a",552:"fb40b428",582:"0ea634d6",595:"c5627647",648:"b629b889",671:"47884a35",705:"e8e607ed",713:"7edac691",780:"b979b06f",827:"e90c30d8",836:"098568bb",880:"c84c8b58",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:"e02982e1",53:"3a2d6a88",80:"883076b5",133:"6862b446",217:"54a24181",252:"9481901e",514:"9062895a",552:"fb40b428",582:"0ea634d6",595:"c5627647",648:"b629b889",671:"47884a35",705:"e8e607ed",713:"7edac691",780:"b979b06f",827:"e90c30d8",836:"098568bb",880:"c84c8b58",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.23.0 - 2023-03-26​

Task now has an official extension for Visual Studio Code contributed by @pd93! 🎉 The extension is maintained in a new repository under the go-task organization. We're looking to gather feedback from the community so please give it a go and let us know what you think via a discussion, issue or on our Discord!

NOTE: -The extension requires v3.23.0 to be installed in order to work.

  • The website was integrated with +

    Changelog

    v3.24.0 - 2023-04-15​

    v3.23.0 - 2023-03-26​

    Task now has an +official extension for Visual Studio Code +contributed by @pd93! 🎉 The extension is maintained in a +new repository under the go-task +organization. We're looking to gather feedback from the community so please give +it a go and let us know what you think via a +discussion, +issue or on our +Discord!

    NOTE: The extension requires v3.23.0 to be installed in order to work.

    • The website was integrated with Crowdin to allow the community to contribute with translations! Chinese is the first language available (#1057, #1058 by @misitebao).
    • Added task location data to the --json flag output (#1056 by @pd93)
    • Change the name of the file generated by task --init from Taskfile.yaml to -Taskfile.yml (#1062 by @misitebao).
    • Added new splitArgs template function ({{splitArgs "foo bar 'foo bar -baz'"}}) to ensure string is split as arguments (#1040, -#1059 by @dhanusaputra).
    • Fix the value of {{.CHECKSUM}} variable in status (#1076, #1080 by @pd93).
    • Fixed deep copy implementation (#1072 by @pd93)
    • Created a tool to assist with releases (#1086 by @pd93).

    v3.22.0 - 2023-03-10​

    • Add a brand new --global (-g) flag that will run a Taskfile from your +Taskfile.yml (#1062 by @misitebao).
    • Added new splitArgs template function +({{splitArgs "foo bar 'foo bar baz'"}}) to ensure string is split as +arguments (#1040, #1059 by @dhanusaputra).
    • Fix the value of {{.CHECKSUM}} variable in status (#1076, #1080 by @pd93).
    • Fixed deep copy implementation (#1072 by @pd93)
    • Created a tool to assist with releases (#1086 by @pd93).

    v3.22.0 - 2023-03-10​

    • Add a brand new --global (-g) flag that will run a Taskfile from your $HOME directory. This is useful to have automation that you can run from anywhere in your system! (Documentation, #1029 @@ -42,29 +54,29 @@ builtins (Documentation).
    • Add new platforms: attribute to task and cmd, so it's now possible to choose in which platforms that given task or command will be run on. Possible values are operating system (GOOS), architecture (GOARCH) or a combination of -the two. Example: platforms: [linux], platforms: [amd64] or platforms: -[linux/amd64]. Other platforms will be skipped (#978, #980 by @leaanthony).

    v3.19.1 - 2022-12-31​

    • Small bug fix: closing Taskfile.yml once we're done reading it -(#963, #964 by @HeCorr).
    • Fixes a bug in v2 that caused a panic when using a Taskfile_{{OS}}.yml file +the two. Example: platforms: [linux], platforms: [amd64] or +platforms: [linux/amd64]. Other platforms will be skipped (#978, #980 by +@leaanthony).

    v3.19.1 - 2022-12-31​

    • Small bug fix: closing Taskfile.yml once we're done reading it (#963, #964 +by @HeCorr).
    • Fixes a bug in v2 that caused a panic when using a Taskfile_{{OS}}.yml file (#961, #971 by @pd93).
    • Fixed a bug where watch intervals set in the Taskfile were not being respected (#969, #970 by @pd93)
    • Add --json flag (alias -j) with the intent to improve support for code editors and add room to other possible integrations. This is basic for now, -but we plan to add more info in the near future -(#936 by @davidalpert, #764).

    v3.19.0 - 2022-12-05​

    • Installation via npm now supports pnpm as well +but we plan to add more info in the near future (#936 by @davidalpert, #764).

    v3.19.0 - 2022-12-05​

    v3.18.0 - 2022-11-12​

    • Show aliases on task --list --silent (task --ls). This means that aliases -will be completed by the completion scripts (#919).
    • Tasks in the root Taskfile will now be displayed first in --list/--list-all -output (#806, #890).
    • It's now possible to call a default task in an included Taskfile by using -just the namespace. For example: docs:default is now automatically -aliased to docs (#661, #815).

    v3.17.0 - 2022-10-14​

    • Add a "Did you mean ...?" suggestion when a task does not exits another one +will be completed by the completion scripts (#919).
    • Tasks in the root Taskfile will now be displayed first in +--list/--list-all output (#806, #890).
    • It's now possible to call a default task in an included Taskfile by using +just the namespace. For example: docs:default is now automatically aliased +to docs (#661, #815).

    v3.17.0 - 2022-10-14​

    • Add a "Did you mean ...?" suggestion when a task does not exits another one with a similar name is found (#867, #880).
    • Now YAML parse errors will print which Taskfile failed to parse (#885, #887).
    • Add ability to set aliases for tasks and namespaces (#268, #340, #879).
    • Improvements to Fish shell completion (#897).
    • Added ability to set a different watch interval by setting interval: '500ms' or using the --interval=500ms flag (#813, #865).
    • Add colored output to --list, --list-all and --summary flags (#845, #874).
    • Fix unexpected behavior where label: was being shown instead of the task -name on --list (#603, #877).

    v3.16.0 - 2022-09-29​

    • Add npm as new installation method: npm i -g [@go](https://github.com/go)-task/cli -(#870, #871, npm package).
    • Add support to marking tasks and includes as internal, which will hide them +name on --list (#603, #877).

    v3.16.0 - 2022-09-29​

    • Add npm as new installation method: npm i -g [@go](https://github.com/go)-task/cli (#870, #871, +npm package).
    • Add support to marking tasks and includes as internal, which will hide them from --list and --list-all (#818).

    v3.15.2 - 2022-09-08​

    • Fix error when using variable in env: introduced in the previous release (#858, #866).
    • Fix handling of CLI_ARGS (--) in Bash completion (#863).
    • On zsh completion, add ability to replace --list-all with --list as already possible on the Bash completion (#861).

    v3.15.0 - 2022-09-03​

    • Add new special variables ROOT_DIR and TASKFILE_DIR. This was a highly @@ -85,15 +97,15 @@ command being ran (#717).

    v3.12.0 - 2022-03-31​

    • The --list and --list-all flags can now be combined with the --silent flag to print the task names only, without their description (#691).
    • Added support for multi-level inclusion of Taskfiles. This means that included Taskfiles can also include other Taskfiles. Before this was limited to one -level (#390, #623, #656).
    • Add ability to specify vars when including a Taskfile. Check out the -documentation for -more information (#677).

    v3.11.0 - 2022-02-19​

    v3.10.0 - 2022-01-04​

    v3.11.0 - 2022-02-19​

    v3.10.0 - 2022-01-04​

    v3.9.0 - 2021-10-02​

    v3.9.0 - 2021-10-02​

    • A new shellQuote function was added to the template system +({{shellQuote "a string"}}) to ensure a string is safe for use in shell (mvdan/sh[#727](https://github.com/go-task/task/issues/727), mvdan/sh[#737](https://github.com/go-task/task/issues/737), Documentation)
    • In this version mvdan.cc/sh was upgraded with @@ -127,39 +139,38 @@ some small fixes and features
      • The read -p flag is now suppor #557).

      v3.7.3 - 2021-09-04​

      v3.7.0 - 2021-07-31​

      • Add run: setting to control if tasks should run multiple times or not. Available options are always (the default), when_changed (if a variable -modified the task) and once (run only once no matter what). -This is a long time requested feature. Enjoy! (#53, #359).

      v3.6.0 - 2021-07-10​

      • Allow using both sources: and status: in the same task (#411, #427, #477).
      • Small optimization and bug fix: don't compute variables if not needed for -dotenv: (#517).

      v3.5.0 - 2021-07-04​

      • Add support for interpolation in dotenv: (#433, #434, #453).

      v3.4.3 - 2021-05-30​

      v3.4.2 - 2021-04-23​

      • On watch, report which file failed to read (#472).
      • Do not try to catch SIGKILL signal, which are not actually possible (#476).
      • Improve version reporting when building Task from source using Go Modules -(#462, #473).

      v3.4.1 - 2021-04-17​

      • Improve error reporting when parsing YAML: in some situations where you -would just see an generic error, you'll now see the actual error with -more detail: the YAML line the failed to parse, for example (#467).
      • A JSON Schema was published here +modified the task) and once (run only once no matter what). This is a long +time requested feature. Enjoy! (#53, #359).

      v3.6.0 - 2021-07-10​

      • Allow using both sources: and status: in the same task (#411, #427, #477).
      • Small optimization and bug fix: don't compute variables if not needed for +dotenv: (#517).

      v3.5.0 - 2021-07-04​

      • Add support for interpolation in dotenv: (#433, #434, #453).

      v3.4.3 - 2021-05-30​

      v3.4.2 - 2021-04-23​

      • On watch, report which file failed to read (#472).
      • Do not try to catch SIGKILL signal, which are not actually possible (#476).
      • Improve version reporting when building Task from source using Go Modules +(#462, #473).

      v3.4.1 - 2021-04-17​

      • Improve error reporting when parsing YAML: in some situations where you would +just see an generic error, you'll now see the actual error with more detail: +the YAML line the failed to parse, for example (#467).
      • A JSON Schema was published here and is automatically being used by some editors like Visual Studio Code -(#135).
      • Print task name before the command in the log output (#398).

      v3.3.0 - 2021-03-20​

      • Add support for delegating CLI arguments to commands with -- and a -special CLI_ARGS variable (#327).
      • Add a --concurrency (alias -C) flag, to limit the number of tasks that -run concurrently. This is useful for heavy workloads. (#345).

      v3.2.2 - 2021-01-12​

      • Improve performance of --list and --summary by skipping running shell -variables for these flags (#332).
      • Fixed a bug where an environment in a Taskfile was not always overridable -by the system environment (#425).
      • Fixed environment from .env files not being available as variables (#379).
      • The install script is now working for ARM platforms (#428).

      v3.2.1 - 2021-01-09​

      • Fixed some bugs and regressions regarding dynamic variables and directories +(#135).
      • Print task name before the command in the log output (#398).

      v3.3.0 - 2021-03-20​

      • Add support for delegating CLI arguments to commands with -- and a special +CLI_ARGS variable (#327).
      • Add a --concurrency (alias -C) flag, to limit the number of tasks that run +concurrently. This is useful for heavy workloads. (#345).

      v3.2.2 - 2021-01-12​

      • Improve performance of --list and --summary by skipping running shell +variables for these flags (#332).
      • Fixed a bug where an environment in a Taskfile was not always overridable by +the system environment (#425).
      • Fixed environment from .env files not being available as variables (#379).
      • The install script is now working for ARM platforms (#428).

      v3.2.1 - 2021-01-09​

      • Fixed some bugs and regressions regarding dynamic variables and directories (#426).
      • The slim-sprig package was updated with the upstream sprig.

      v3.2.0 - 2021-01-07​

      • Fix the .task directory being created in the task directory instead of the -Taskfile directory (#247).
      • Fix a bug where dynamic variables (those declared with sh:) were not -running in the task directory when the task has a custom dir or it was -in an included Taskfile (#384).
      • The watch feature (via the --watch flag) got a few different bug fixes and -should be more stable now (#423, #365).

      v3.1.0 - 2021-01-03​

      • Fix a bug when the checksum up-to-date resolution is used by a task -with a custom label: attribute (#412).
      • Starting from this release, we're releasing official ARMv6 and ARM64 binaries +Taskfile directory (#247).
      • Fix a bug where dynamic variables (those declared with sh:) were not running +in the task directory when the task has a custom dir or it was in an included +Taskfile (#384).
      • The watch feature (via the --watch flag) got a few different bug fixes and +should be more stable now (#423, #365).

      v3.1.0 - 2021-01-03​

      • Fix a bug when the checksum up-to-date resolution is used by a task with a +custom label: attribute (#412).
      • Starting from this release, we're releasing official ARMv6 and ARM64 binaries for Linux (#375, #418).
      • Task now respects the order of declaration of included Taskfiles when evaluating variables declaring by them (#393).
      • set -e is now automatically set on every command. This was done to fix an -issue where multiline string commands wouldn't really fail unless the -sentence was in the last line (#403).

      v3.0.1 - 2020-12-26​

      • Allow use as a library by moving the required packages out of the internal +issue where multiline string commands wouldn't really fail unless the sentence +was in the last line (#403).

      v3.0.1 - 2020-12-26​

      • Allow use as a library by moving the required packages out of the internal directory (#358).
      • Do not error if a specified dotenv file does not exist (#378, #385).
      • Fix panic when you have empty tasks in your Taskfile (#338, #362).

      v3.0.0 - 2020-08-16​

      • On v3, all CLI variables will be considered global variables (#336, #341)
      • Add support to .env like files (#324, #356).
      • Add label: to task so you can override the task name in the logs ([#321](https://github.com/go-task/task/issues/321), #337).
      • Refactor how variables work on version 3 (#311).
      • Disallow expansions on v3 since it has no effect.
      • Taskvars.yml is not automatically included anymore.
      • Taskfile_{{OS}}.yml is not automatically included anymore.
      • Allow interpolation on includes, so you can manually include a Taskfile based on operation system, for example.
      • Expose .TASK variable in templates with the task name (#252).
      • Implement short task syntax (#194, #240).
      • Added option to make included Taskfile run commands on its own directory -(#260, #144)
      • Taskfiles in version 1 are not supported anymore (#237).
      • Added global method: option. With this option, you can set a default -method to all tasks in a Taskfile (#246).
      • Changed default method from timestamp to checksum (#246).
      • New magic variables are now available when using status:: -.TIMESTAMP which contains the greatest modification date -from the files listed in sources:, and .CHECKSUM, which -contains a checksum of all files listed in status:. +(#260, #144)
      • Taskfiles in version 1 are not supported anymore (#237).
      • Added global method: option. With this option, you can set a default method +to all tasks in a Taskfile (#246).
      • Changed default method from timestamp to checksum (#246).
      • New magic variables are now available when using status:: .TIMESTAMP which +contains the greatest modification date from the files listed in sources:, +and .CHECKSUM, which contains a checksum of all files listed in status:. This is useful for manual checking when using external, or even remote, artifacts when using status: (#216).
      • We're now using slim-sprig instead of sprig, which allowed a file size @@ -168,21 +179,23 @@ commands are green, errors are red, etc (#266).
      • Fixed bug where calling the task CLI only informing global vars would not execute the default task.
      • Add hability to silent all tasks by adding silent: true a the root of the Taskfile.

      v2.7.1 - 2019-11-10​

      • Fix error being raised when exit 0 was called (#251).

      v2.7.0 - 2019-09-22​

      • Fixed panic bug when assigning a global variable (#229, #243).
      • A task with method: checksum will now re-run if generated files are deleted -(#228, #238).

      v2.6.0 - 2019-07-21​

      • Fixed some bugs regarding minor version checks on version:.
      • Add preconditions: to task (#205).
      • Create directory informed on dir: if it doesn't exist (#209, #211).
      • We now have a --taskfile flag (alias -t), which can be used to run -another Taskfile (other than the default Taskfile.yml) (#221).
      • It's now possible to install Task using Homebrew on Linux -(go-task/homebrew-tap[#1](https://github.com/go-task/task/issues/1)).

      v2.5.2 - 2019-05-11​

      2.5.1 - 2019-04-27​

      • Fixed some issues with interactive command line tools, where sometimes the +(#228, #238).

      v2.6.0 - 2019-07-21​

      • Fixed some bugs regarding minor version checks on version:.
      • Add preconditions: to task (#205).
      • Create directory informed on dir: if it doesn't exist (#209, #211).
      • We now have a --taskfile flag (alias -t), which can be used to run another +Taskfile (other than the default Taskfile.yml) (#221).
      • It's now possible to install Task using Homebrew on Linux +(go-task/homebrew-tap[#1](https://github.com/go-task/task/issues/1)).

      v2.5.2 - 2019-05-11​

      2.5.1 - 2019-04-27​

      • Fixed some issues with interactive command line tools, where sometimes the output were not being shown, and similar issues (#114, #190, #200).
      • Upgraded go-yaml/yaml from v2 to v3.

      v2.5.0 - 2019-03-16​

      v2.4.0 - 2019-02-21​

      v2.4.0 - 2019-02-21​

      • Allow calling a task of the root Taskfile from an included Taskfile by prefixing it with : (#161, #172).
      • Add flag to override the output option (#173).
      • Fix bug where Task was persisting the new checksum on the disk when the Dry Mode is enabled (#166).
      • Fix file timestamp issue when the file name has spaces (#176).
      • Mitigating path expanding issues on Windows (#170).

      v2.3.0 - 2019-01-02​

      • On Windows, Task can now be installed using Scoop (#152).
      • Fixed issue with file/directory globing (#153).
      • Added ability to globally set environment variables (#138, #159).

      v2.2.1 - 2018-12-09​

      • This repository now uses Go Modules (#143). We'll still keep the vendor directory in sync for some time, though;
      • Fixing a bug when the Taskfile has no tasks but includes another Taskfile (#150);
      • Fix a bug when calling another task or a dependency in an included Taskfile -(#151).

      v2.2.0 - 2018-10-25​

      • Added support for including other -Taskfiles (#98)
        • This should be considered experimental. For now, only including local files +(#151).

        v2.2.0 - 2018-10-25​

        • Added support for +including other Taskfiles +(#98)
          • This should be considered experimental. For now, only including local files is supported, but support for including remote Taskfiles is being discussed. If you have any feedback, please comment on #98.
        • Task now have a dedicated documentation site: https://taskfile.org
          • Thanks to Docsify for making this pretty easy. To check the source code, just take a look at the @@ -190,15 +203,15 @@ check the source code, just take a look at the repository. Contributions to the documentation is really appreciated.

        v2.1.1 - 2018-09-17​

        • Fix suggestion to use task --init not being shown anymore (when a Taskfile.yml is not found)
        • Fix error when using checksum method and no file exists for a source glob (#131)
        • Fix signal handling when the --watch flag is given (#132)

        v2.1.0 - 2018-08-19​

        • Add a ignore_error option to task and command (#123)
        • Add a dry run mode (--dry flag) (#126)

        v2.0.3 - 2018-06-24​

        • Expand environment variables on "dir", "sources" and "generates" (#116)
        • Fix YAML merging syntax (#112)
        • Add ZSH completion (#111)
        • Implement new output option. Please check out the -documentation

        v2.0.2 - 2018-05-01​

        • Fix merging of YAML anchors (#112)

        v2.0.1 - 2018-03-11​

        • Fixes panic on task --list

        v2.0.0 - 2018-03-08​

        Version 2.0.0 is here, with a new Taskfile format.

        -Please, make sure to read the Taskfile --versions --document, since it describes in depth what changed for this version.

        • New Taskfile version 2 (#77)
        • Possibility to have global variables in the Taskfile.yml instead of +documentation

        v2.0.2 - 2018-05-01​

        • Fix merging of YAML anchors (#112)

        v2.0.1 - 2018-03-11​

        • Fixes panic on task --list

        v2.0.0 - 2018-03-08​

        Version 2.0.0 is here, with a new Taskfile format.

        Please, make sure to read the +Taskfile versions +document, since it describes in depth what changed for this version.

        • New Taskfile version 2 (#77)
        • Possibility to have global variables in the Taskfile.yml instead of Taskvars.yml (#66)
        • Small improvements and fixes

        v1.4.4 - 2017-11-19​

        • Handle SIGINT and SIGTERM (#75);
        • List: print message with there's no task with description;
        • Expand home dir ("~" symbol) on paths (#74);
        • Add Snap as an installation method;
        • Move examples to its own repo;
        • Watch: also walk on tasks called on on "cmds", and not only on "deps";
        • Print logs to stderr instead of stdout (#68);
        • Remove deprecated set keyword;
        • Add checksum based status check, alternative to timestamp based.

        v1.4.3 - 2017-09-07​

        • Allow assigning variables to tasks at run time via CLI (#33)
        • Added suport for multiline variables from sh (#64)
        • Fixes env: remove square braces and evaluate shell (#62)
        • Watch: change watch library and few fixes and improvements
        • When use watching, cancel and restart long running process on file change (#59 and #60)

        v1.4.2 - 2017-07-30​

        • Flag to set directory of execution
        • Always echo command if is verbose mode
        • Add silent mode to disable echoing of commands
        • Fixes and improvements of variables (#56)

        v1.4.1 - 2017-07-15​

        • Allow use of YAML for dynamic variables instead of $ prefix
          • VAR: {sh: echo Hello} instead of VAR: $echo Hello
        • Add --list (or -l) flag to print existing tasks
        • OS specific Taskvars file (e.g. Taskvars_windows.yml, Taskvars_linux.yml, etc)
        • Consider task up-to-date on equal timestamps (#49)
        • Allow absolute path in generates section (#48)
        • Bugfix: allow templating when calling deps (#42)
        • Fix panic for invalid task in cyclic dep detection
        • Better error output for dynamic variables in Taskvars.yml (#41)
        • Allow template evaluation in parameters

        v1.4.0 - 2017-07-06​

        • Cache dynamic variables
        • Add verbose mode (-v flag)
        • Support to task parameters (overriding vars) (#31) (#32)
        • Print command, also when "set:" is specified (#35)
        • Improve task command help text (#35)

        v1.3.1 - 2017-06-14​

        • Fix glob not working on commands (#28)
        • Add ExeExt template function
        • Add --init flag to create a new Taskfile
        • Add status option to prevent task from running (#27)
        • Allow interpolation on generates and sources attributes (#26)

        v1.3.0 - 2017-04-24​

        • Migrate from os/exec.Cmd to a native Go sh/bash interpreter
          • This is a potentially breaking change if you use Windows.
          • Now, cmd is not used anymore on Windows. Always use Bash-like syntax for your commands, even on Windows.
        • Add "ToSlash" and "FromSlash" to template functions
        • Use functions defined on github.com/Masterminds/sprig
        • Do not redirect stdin while running variables commands
        • Using context and errgroup packages (this will make other tasks to be -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
- +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 31935e1e..7e38f02b 100644 --- a/community/index.html +++ b/community/index.html @@ -10,7 +10,7 @@ - + @@ -44,7 +44,7 @@ natively.

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 22ac1db6..5ea27b39 100644 --- a/contributing/index.html +++ b/contributing/index.html @@ -10,7 +10,7 @@ - + @@ -66,7 +66,7 @@ contributions.

All kinds of contributions are welcome, whether its a typo 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 17f90a45..e4e0f0d9 100644 --- a/donate/index.html +++ b/donate/index.html @@ -10,7 +10,7 @@ - + @@ -24,7 +24,7 @@ the website homepage and on the GitHub repository README. Make contact with the following links to do your donation:

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 97c785e3..83451afc 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 025b5c9f..5a8f2cc8 100644 --- a/index.html +++ b/index.html @@ -10,7 +10,7 @@ - + @@ -29,7 +29,7 @@ Task also supports Windows thanks to 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 488f0034..ebfe4d49 100644 --- a/installation/index.html +++ b/installation/index.html @@ -10,7 +10,7 @@ - + @@ -51,7 +51,7 @@ setup. You can find the minimum required version of Go in the 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 03e6d46c..bf984e0d 100644 --- a/releasing/index.html +++ b/releasing/index.html @@ -10,7 +10,7 @@ - + @@ -34,7 +34,7 @@ If you think its Task version is outdated, open an issue to let us know.

take care 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 50d285aa..dbac0c1b 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 d40fbeb9..bf51365d 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 d2ea214a..10e02be0 100644 --- a/taskfile-versions/index.html +++ b/taskfile-versions/index.html @@ -10,7 +10,7 @@ - + @@ -36,7 +36,7 @@ included Taskfile will run:
- + \ No newline at end of file diff --git a/translate/index.html b/translate/index.html index 82f367d0..6ee4543c 100644 --- a/translate/index.html +++ b/translate/index.html @@ -10,7 +10,7 @@ - + @@ -21,7 +21,7 @@ is periodically updated with progress from Crowdin.

If you want to have ac 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 d72d5ef9..716020d5 100644 --- a/usage/index.html +++ b/usage/index.html @@ -10,7 +10,7 @@ - + @@ -213,7 +213,7 @@ task again. This requires the sources attribute to be given, so tas 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