From 1d83bd8904bbf2449be36cb00c52136fdc6d2b72 Mon Sep 17 00:00:00 2001 From: task-bot <106601941+task-bot@users.noreply.github.com> Date: Fri, 17 Jun 2022 13:06:28 +0000 Subject: [PATCH] deploy: 0c46fa5a561946e967c7c0ac6d041f88466bf16c --- 404.html | 4 ++-- api/index.html | 6 +++--- assets/js/f7fd502c.69324c50.js | 1 + assets/js/f7fd502c.b6c2546d.js | 1 - .../{runtime~main.ae71d5cd.js => runtime~main.fe2ff5fc.js} | 2 +- changelog/index.html | 4 ++-- community/index.html | 4 ++-- donate/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 ++-- usage/index.html | 4 ++-- 15 files changed, 27 insertions(+), 27 deletions(-) create mode 100644 assets/js/f7fd502c.69324c50.js delete mode 100644 assets/js/f7fd502c.b6c2546d.js rename assets/js/{runtime~main.ae71d5cd.js => runtime~main.fe2ff5fc.js} (98%) diff --git a/404.html b/404.html index 3e725d75..ace036d0 100644 --- a/404.html +++ b/404.html @@ -12,13 +12,13 @@ Page Not Found | Task - +
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 0a4ecc06..ed11a3d9 100644 --- a/api/index.html +++ b/api/index.html @@ -12,17 +12,17 @@ API Reference | Task - +
-
Skip to main content

API Reference

CLI​

Task command line tool has the following syntax:

task [--flags] [tasks...] [-- CLI_ARGS...]
tip

If -- is given, all remaning arguments to assigned to a special CLI_ARGS +

API Reference

CLI​

Task command line tool has the following syntax:

task [--flags] [tasks...] [-- CLI_ARGS...]
tip

If -- is given, all remaning arguments will be assigned to a special CLI_ARGS variable

ShortFlagTypeDefaultDescription
-c--colorbooltrueColored output. Enabled by default. Set flag to false or use NO_COLOR=1 to disable.
-C--concurrencyint0Limit number tasks to run concurrently. Zero means unlimited.
-d--dirstringWorking directorySets directory of execution.
-n--dryboolfalseCompiles and prints tasks in the order that they would be run, without executing them.
-x--exit-codeboolfalsePass-through the exit code of the task command.
-f--forceboolfalseForces execution even when the task is up-to-date.
-h--helpboolfalseShows Task usage.
-i--initboolfalseCreates a new Taskfile.yaml in the current folder.
-l--listboolfalseLists tasks with description of current Taskfile.
-a--list-allboolfalseLists tasks with or without a description.
-o--outputstringDefault set in the Taskfile or intervealedSets output style: [interleaved/group/prefixed].
--output-group-beginstringMessage template to print before a task's grouped output.
--output-group-end stringMessage template to print after a task's grouped output.
-p--parallelboolfalseExecutes tasks provided on command line in parallel.
-s--silentboolfalseDisables echoing.
--statusboolfalseExits with non-zero exit code if any of the given tasks is not up-to-date.
--summaryboolfalseShow summary about a task.
-t--taskfilestringTaskfile.yml or Taskfile.yaml
-v--verboseboolfalseEnables verbose mode.
--versionboolfalseShow Task version.
-w--watchboolfalseEnables watch of the given task.

Schema​

Taskfile​

AttributeTypeDefaultDescription
versionstringVersion of the Taskfile. The current version is 3.
includesmap[string]IncludeAdditional Taskfiles to be included.
outputstringinterleavedOutput mode. Available options: interleaved, group and prefixed.
methodstringchecksumDefault method in this Taskfile. Can be overriden in a task by task basis. Available options: checksum, timestamp and none.
silentboolfalseDefault "silent" options for this Taskfile. If false, can be overidden with true in a task by task basis.
runstringalwaysDefault "run" option for this Taskfile. Available options: always, once and when_changed.
varsmap[string]VariableGlobal variables.
envmap[string]VariableGlobal environment.
dotenv[]stringA list of .env file paths to be parsed.
tasksmap[string]TaskThe task definitions.

Include​

AttributeTypeDefaultDescription
taskfilestringThe path for the Taskfile or directory to be included. If a directory, Task will look for files named Taskfile.yml or Taskfile.yaml inside that directory.
dirstringThe parent Taskfile directoryThe working directory of the included tasks when run.
optionalboolfalseIf true, no errors will be thrown if the specified file does not exist.
info

Informing only a string like below is equivalent to setting that value to the taskfile attribute.

includes:
  foo: ./path

Task​

AttributeTypeDefaultDescription
descstringA short description of the task. This is listed when calling task --list.
summarystringA longer description of the task. This is listed when calling task --summary [task].
sources[]stringList of sources to check before running this task. Relevant for checksum and timestamp methods. Can be file paths or star globs.
dirstringThe current directory which this task should run.
methodstringchecksumMethod used by this task. Default to the one declared globally or checksum. Available options: checksum, timestamp and none
silentboolfalseSkips some output for this task. Note that STDOUT and STDERR of the commands will still be redirected.
runstringThe one declared globally in the Taskfile or alwaysSpecifies whether the task should run again or not if called more than once. Available options: always, once and when_changed.
prefixstringAllows to override the prefix print before the STDOUT. Only relevant when using the prefixed output mode.
ignore_errorboolfalseContinue execution if errors happen while executing the commands.
generates[]stringList of files meant to be generated by this task. Relevant for timestamp method. Can be file paths or star globs.
status[]stringList of commands to check if this task should run. The task is skipped otherwise. This overrides method, sources and generates.
preconditions[]PreconditionList of commands to check if this task should run. The task errors otherwise.
varsmap[string]VariableTask variables.
envmap[string]VariableTask environment.
deps[]DependencyList of dependencies of this task.
cmds[]CommandList of commands to be executed.
info

These alternative syntaxes are available. They will set the given values to cmds and everything else will be set to their default values:

tasks:
  foo: echo "foo"

  foobar:
    - 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]

Command​

AttributeTypeDefaultDescription
cmdstringThe shell command to be executed.
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.
silentboolfalseSkips some output for this command. Note that STDOUT and STDERR of the commands will still be redirected.
ignore_errorboolfalseContinue execution if errors happen while executing the command.
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.
info

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

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

Variable​

AttributeTypeDefaultDescription
itselfstringA static value that will be set to the variable.
shstringA shell command. The output (STDOUT) will be assigned to the variable.
info

Static and dynamic variables have different syntaxes, like below:

vars:
  STATIC: static
  DYNAMIC:
    sh: echo "dynamic"

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/f7fd502c.69324c50.js b/assets/js/f7fd502c.69324c50.js new file mode 100644 index 00000000..583c38a4 --- /dev/null +++ b/assets/js/f7fd502c.69324c50.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktaskfile_dev=self.webpackChunktaskfile_dev||[]).push([[582],{3905:function(t,e,n){n.d(e,{Zo:function(){return o},kt:function(){return s}});var a=n(7294);function l(t,e,n){return e in t?Object.defineProperty(t,e,{value:n,enumerable:!0,configurable:!0,writable:!0}):t[e]=n,t}function r(t,e){var n=Object.keys(t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(t);e&&(a=a.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),n.push.apply(n,a)}return n}function i(t){for(var e=1;e=0||(l[n]=t[n]);return l}(t,e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(l[n]=t[n])}return l}var m=a.createContext({}),p=function(t){var e=a.useContext(m),n=e;return t&&(n="function"==typeof t?t(e):i(i({},e),t)),n},o=function(t){var e=p(t.components);return a.createElement(m.Provider,{value:e},t.children)},k={inlineCode:"code",wrapper:function(t){var e=t.children;return a.createElement(a.Fragment,{},e)}},N=a.forwardRef((function(t,e){var n=t.components,l=t.mdxType,r=t.originalType,m=t.parentName,o=d(t,["components","mdxType","originalType","parentName"]),N=p(n),s=l,u=N["".concat(m,".").concat(s)]||N[s]||k[s]||r;return n?a.createElement(u,i(i({ref:e},o),{},{components:n})):a.createElement(u,i({ref:e},o))}));function s(t,e){var n=arguments,l=e&&e.mdxType;if("string"==typeof t||l){var r=n.length,i=new Array(r);i[0]=N;var d={};for(var m in e)hasOwnProperty.call(e,m)&&(d[m]=e[m]);d.originalType=t,d.mdxType="string"==typeof t?t:l,i[1]=d;for(var p=2;p=0||(l[n]=t[n]);return l}(t,e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(l[n]=t[n])}return l}var m=a.createContext({}),p=function(t){var e=a.useContext(m),n=e;return t&&(n="function"==typeof t?t(e):i(i({},e),t)),n},o=function(t){var e=p(t.components);return a.createElement(m.Provider,{value:e},t.children)},k={inlineCode:"code",wrapper:function(t){var e=t.children;return a.createElement(a.Fragment,{},e)}},N=a.forwardRef((function(t,e){var n=t.components,l=t.mdxType,r=t.originalType,m=t.parentName,o=d(t,["components","mdxType","originalType","parentName"]),N=p(n),s=l,u=N["".concat(m,".").concat(s)]||N[s]||k[s]||r;return n?a.createElement(u,i(i({ref:e},o),{},{components:n})):a.createElement(u,i({ref:e},o))}));function s(t,e){var n=arguments,l=e&&e.mdxType;if("string"==typeof t||l){var r=n.length,i=new Array(r);i[0]=N;var d={};for(var m in e)hasOwnProperty.call(e,m)&&(d[m]=e[m]);d.originalType=t,d.mdxType="string"==typeof t?t:l,i[1]=d;for(var p=2;p=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/"+({53:"935f2afb",80:"9beb87c2",133:"f1d66b0d",217:"3b8c55ea",514:"1be78505",552:"0afd354a",582:"f7fd502c",595:"d0766b26",648:"3c140c84",671:"0e384e19",705:"7d415946",713:"1c56b476",827:"6476eba6",880:"5ef0e9d6",918:"17896441",920:"1a4e3797"}[e]||e)+"."+{53:"b56dc85c",80:"63126c88",133:"6862b446",217:"95e12a57",514:"39ae2946",552:"3d55476b",582:"b6c2546d",595:"c5627647",608:"10f8675e",648:"c2d43167",671:"9f4f9558",705:"d16538a2",713:"4d29163e",780:"8efbf5ce",827:"690c9010",880:"e861607f",894:"4bf7d380",918:"58fb0a3d",920:"eb9e742a",945:"3694633c"}[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/"+({53:"935f2afb",80:"9beb87c2",133:"f1d66b0d",217:"3b8c55ea",514:"1be78505",552:"0afd354a",582:"f7fd502c",595:"d0766b26",648:"3c140c84",671:"0e384e19",705:"7d415946",713:"1c56b476",827:"6476eba6",880:"5ef0e9d6",918:"17896441",920:"1a4e3797"}[e]||e)+"."+{53:"b56dc85c",80:"63126c88",133:"6862b446",217:"95e12a57",514:"39ae2946",552:"3d55476b",582:"69324c50",595:"c5627647",608:"10f8675e",648:"c2d43167",671:"9f4f9558",705:"d16538a2",713:"4d29163e",780:"8efbf5ce",827:"690c9010",880:"e861607f",894:"4bf7d380",918:"58fb0a3d",920:"eb9e742a",945:"3694633c"}[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
- + \ No newline at end of file diff --git a/community/index.html b/community/index.html index 6507a604..4b2f5a10 100644 --- a/community/index.html +++ b/community/index.html @@ -12,7 +12,7 @@ Community | Task - + @@ -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/donate/index.html b/donate/index.html index 9a6917fe..dbf04fc7 100644 --- a/donate/index.html +++ b/donate/index.html @@ -12,7 +12,7 @@ Donate | Task - + @@ -22,7 +22,7 @@ channels listed below.

This is just a way of saying "thank you", higher priority on issues or something similar.

Open Collective​

Task is on Open Collective and you have these options to donate:

GitHub Sponsors​

PayPal​

PIX (Brazil only)​

If you're Brazilian, you can donate any value by using this QR Code.

- + \ No newline at end of file diff --git a/index.html b/index.html index e0126921..f5c61303 100644 --- a/index.html +++ b/index.html @@ -12,7 +12,7 @@ Home | Task - + @@ -29,7 +29,7 @@ to install on your CI script and you're done to use Task as part of your CI 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).
    • - + \ No newline at end of file diff --git a/installation/index.html b/installation/index.html index e8aaced8..b35dd6a2 100644 --- a/installation/index.html +++ b/installation/index.html @@ -12,7 +12,7 @@ Installation | Task - + @@ -38,7 +38,7 @@ easy generation of this script.

    - name: Install Task
      uses: arduino/setup-task@v1

    This installation method is community owned.

    Build From Source​

    Go Modules​

    First, make sure you have Go properly installed and setup.

    You can easily 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

    If using Go 1.15 or earlier, instead use:

    env GO111MODULE=on go get -u 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.

    - + \ No newline at end of file diff --git a/releasing/index.html b/releasing/index.html index de5b186e..0b5cefb2 100644 --- a/releasing/index.html +++ b/releasing/index.html @@ -12,7 +12,7 @@ Releasing | Task - + @@ -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 b3f62d5a..1d44e6f8 100644 --- a/search/index.html +++ b/search/index.html @@ -12,13 +12,13 @@ Search the documentation | Task - +
    Skip to main content

    Search the documentation

    - + \ No newline at end of file diff --git a/styleguide/index.html b/styleguide/index.html index d9c16ec7..823f9fa2 100644 --- a/styleguide/index.html +++ b/styleguide/index.html @@ -12,7 +12,7 @@ Styleguide | Task - + @@ -25,7 +25,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​

    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 7c481675..169d44c4 100644 --- a/taskfile-versions/index.html +++ b/taskfile-versions/index.html @@ -12,7 +12,7 @@ Taskfile Versions | Task - + @@ -40,7 +40,7 @@ included Taskfile will run:
    - + \ No newline at end of file diff --git a/usage/index.html b/usage/index.html index 1dbb5d7a..e43325e4 100644 --- a/usage/index.html +++ b/usage/index.html @@ -12,7 +12,7 @@ Usage | Task - + @@ -153,7 +153,7 @@ an issue about it.

    version: '3'

    tasks:
      build: go build -v -o ./app{{exeExt}} .

      run:
        - task: build
        - ./app{{exeExt}} -h localhost -p 8080

    Watch tasks​

    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.

    - + \ No newline at end of file