Merge branch 'master' into v3

docs/_sidebar.md

@@ -1,5 +1,6 @@
 - [Installation](installation.md)
 - [Usage](usage.md)
+- [Styleguide](styleguide.md)
 - [Taskfile Versions](taskfile_versions.md)
 - [Examples](examples.md)
 - [Releasing Task](releasing_task.md)

docs/installation.md

@@ -43,18 +43,13 @@ may take some time until it's available on Scoop.
 ## Go
 
 Task now uses [Go Modules](https://github.com/golang/go/wiki/Modules), which
-means you may have trouble compiling it on older Go versions.
+means you may have trouble compiling it on older Go versions or using
+`$GOPATH`.
 
 For CI environments we recommend using the [Install Script](#install-script)
 instead, which is faster and more stable, since it'll just download the latest
 released binary, instead of compiling the edge (master branch) version.
 
-Installing in your `$GOPATH`:
-
-```bash
-go get -u -v github.com/go-task/task/cmd/task
-```
-
 Installing in another directory:
 
 ```bash
@@ -62,7 +57,7 @@ git clone https://github.com/go-task/task
 cd task
 
 # compiling binary to $GOPATH/bin
-go install -v
+go install -v ./cmd/task
 
 # compiling it to another location
 # use -o ./task.exe on Windows
@@ -83,6 +78,19 @@ curl -sL https://taskfile.dev/install.sh | sh
 
 > This method will download the binary on the local `./bin` directory by default.
 
+## GitHub Actions
+
+If you want to install Task in GitHub Actions you can try using
+[this action](https://github.com/arduino/actions/tree/master/setup-taskfile)
+by the Arduino team:
+
+```yaml
+- name: Install Task
+  uses: Arduino/actions/setup-taskfile@master
+```
+
+This installation method is community owned.
+
 [go]: https://golang.org/
 [snapcraft]: https://snapcraft.io/
 [homebrew]: https://brew.sh/

docs/styleguide.md

@@ -0,0 +1,213 @@
+# Styleguide
+
+This is the official Task styleguide for `Taskfile.yml` files. This guide
+contains some basic instructions to keep your Taskfile clean and familiar to
+other users.
+
+This contains general guidelines, but don't necessarely need to be strictly
+followed. Feel free to disagree and proceed differently in some point if you
+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`
+
+```yaml
+# bad
+taskfile.yml
+
+
+# good
+Taskfile.yml
+```
+
+This is important to specially to 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:` and `expansions:`
+- `vars:`
+- `env:`
+- `tasks:`
+
+## Use 2 spaces for indentation
+
+This is the most common convention for YAML files, and Task follows it.
+
+```yaml
+# bad
+tasks:
+    foo:
+        cmds:
+            - echo 'foo'
+
+
+# good
+tasks:
+  foo:
+    cmds:
+      - echo 'foo'
+```
+
+## Separate with spaces the mains sections
+
+```yaml
+# bad
+version: 2
+includes:
+  docker: ./docker/Taskfile.yml
+output: prefixed
+expansions: 3
+vars:
+  FOO: bar
+env:
+  BAR: baz
+tasks:
+  # ...
+
+
+# good
+version: 2
+
+includes:
+  docker: ./docker/Taskfile.yml
+
+output: prefixed
+expansions: 3
+
+vars:
+  FOO: bar
+
+env:
+  BAR: baz
+
+tasks:
+  # ...
+```
+
+## Add spaces between tasks
+
+```yaml
+# bad
+version: 2
+
+tasks:
+  foo:
+    cmds:
+      - echo 'foo'
+  bar:
+    cmds:
+      - echo 'bar'
+  baz:
+    cmds:
+      - echo 'baz'
+
+
+# good
+version: 2
+
+tasks:
+  foo:
+    cmds:
+      - echo 'foo'
+
+  bar:
+    cmds:
+      - echo 'bar'
+
+  baz:
+    cmds:
+      - echo 'baz'
+```
+
+## Use upper-case variable names
+
+```yaml
+# bad
+version: 2
+
+vars:
+  binary_name: myapp
+
+tasks:
+  build:
+    cmds:
+      - go build -o {{.binary_name}} .
+
+
+# good
+version: 2
+
+vars:
+  BINARY_NAME: myapp
+
+tasks:
+  build:
+    cmds:
+      - go build -o {{.BINARY_NAME}} .
+```
+
+## Don't wrap vars in spaces when templating
+
+```yaml
+# bad
+version: 2
+
+tasks:
+  greet:
+    cmds:
+      - echo '{{ .MESSAGE }}'
+
+
+# good
+version: 2
+
+tasks:
+  greet:
+    cmds:
+      - echo '{{.MESSAGE}}'
+```
+
+This convention is also used by most people for any Go templating.
+
+## Separate task name words with a dash
+
+```yaml
+# bad
+version: 2
+
+tasks:
+  do_something_fancy:
+    cmds:
+      - echo 'Do something'
+
+
+# good
+version: 2
+
+tasks:
+  do-something-fancy:
+    cmds:
+      - echo 'Do something'
+```
+
+## Use colon for task namespacing
+
+```yaml
+# good
+version: 2
+
+tasks:
+  docker:build:
+    cmds:
+      - docker ...
+
+  docker:run:
+    cmds:
+      - docker-compose ...
+```
+
+This is also done automatically when using included Taskfiles.