go/task
1
0
Fork 0
mirror of https://github.com/go-task/task.git synced 2025-11-23 22:24:45 +02:00
Code Issues Releases Activity

fix: links to static files

Browse Source
This commit is contained in:
Pete Davison
2025-09-23 22:34:43 +00:00
parent 0f9baf62a1
commit 4e84c6bb76
4 changed files with 34 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
.vscode/settings-sample.json vendored
View File

@@ -1,15 +1,12 @@
{ {
"yaml.schemas": { "yaml.schemas": {
"./website/static/schema.json": [ "./website/src/public/schema.json": [
"Taskfile.yml", "Taskfile.yml",
"tmp/**/*.yml" "Taskfile.yaml",
"taskfile.yml",
"taskfile.yaml"
] ]
}, },
"search.exclude": {
"**/versioned_docs": true,
"**/versioned_sidesbars": true,
"**/i18n": true
},
"gopls": { "gopls": {
"formatting.local": "github.com/go-task" "formatting.local": "github.com/go-task"
}, },

22
website/src/docs/contributing.md
View File

@@ -30,10 +30,10 @@ Studio Code][vscode-task].
you invest your time into a PR. you invest your time into a PR.
- **Experiments** - If there is no way to make your change backward compatible - **Experiments** - If there is no way to make your change backward compatible
then there is a procedure to introduce breaking changes into minor versions. then there is a procedure to introduce breaking changes into minor versions.
We call these "[experiments](./experiments/index.md)". If you're intending to work on We call these "[experiments](./experiments/index.md)". If you're intending to
an experiment, then please read the work on an experiment, then please read the
[experiments workflow](./experiments/index.md#workflow) document carefully and submit a [experiments workflow](./experiments/index.md#workflow) document carefully and
proposal first. submit a proposal first.
## 1. Setup ## 1. Setup
@@ -85,12 +85,12 @@ by using `task website` (requires `nodejs` & `pnpm`). All content is written in
Markdown and is located in the `website/src` directory. All Markdown documents Markdown and is located in the `website/src` directory. All Markdown documents
should have an 80 character line wrap limit (enforced by Prettier). should have an 80 character line wrap limit (enforced by Prettier).
When making a change, consider whether a change to the [Usage Guide](/docs/guide) is When making a change, consider whether a change to the
necessary. This document contains descriptions and examples of how to use Task [Usage Guide](/docs/guide) is necessary. This document contains descriptions and
features. If you're adding a new feature, try to find an appropriate place to examples of how to use Task features. If you're adding a new feature, try to
add a new section. If you're updating an existing feature, ensure that the find an appropriate place to add a new section. If you're updating an existing
documentation and any examples are up-to-date. Ensure that any examples follow feature, ensure that the documentation and any examples are up-to-date. Ensure
the [Taskfile Styleguide](./styleguide.md). that any examples follow the [Taskfile Styleguide](./styleguide.md).
If you added a new command or flag, ensure that you add it to the If you added a new command or flag, ensure that you add it to the
[CLI Reference](./reference/cli.md). New fields also need to be added to the [CLI Reference](./reference/cli.md). New fields also need to be added to the
@@ -168,7 +168,7 @@ If you have questions, feel free to ask them in the `#help` forum channel on our
[pnpm]: https://pnpm.io/ [pnpm]: https://pnpm.io/
[vitepress]: https://vitepress.dev [vitepress]: https://vitepress.dev
[json-schema]: [json-schema]:
https://github.com/go-task/task/blob/main/website/static/schema.json https://github.com/go-task/task/blob/main/website/src/public/schema.json
[task-open-issues]: https://github.com/go-task/task/issues [task-open-issues]: https://github.com/go-task/task/issues
[vscode-task-open-issues]: https://github.com/go-task/vscode-task/issues [vscode-task-open-issues]: https://github.com/go-task/vscode-task/issues
[good-first-issue]: [good-first-issue]:

32
website/src/docs/experiments/remote-taskfiles.md
View File

@@ -39,15 +39,15 @@ of node which you can use:
::: code-group ::: code-group
```text [HTTP/HTTPS] ```text [HTTP/HTTPS]
https://raw.githubusercontent.com/go-task/task/main/website/static/Taskfile.yml https://raw.githubusercontent.com/go-task/task/main/website/src/public/Taskfile.yml
``` ```
```text [Git over HTTP] ```text [Git over HTTP]
https://github.com/go-task/task.git//website/static/Taskfile.yml?ref=main https://github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main
``` ```
```text [Git over SSH] ```text [Git over SSH]
git@github.com/go-task/task.git//website/static/Taskfile.yml?ref=main git@github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main
``` ```
::: :::
@@ -56,7 +56,7 @@ git@github.com/go-task/task.git//website/static/Taskfile.yml?ref=main
### HTTP/HTTPS ### HTTP/HTTPS
`https://raw.githubusercontent.com/go-task/task/main/website/static/Taskfile.yml` `https://raw.githubusercontent.com/go-task/task/main/website/src/public/Taskfile.yml`
This is the most basic type of remote node and works by downloading the file This is the most basic type of remote node and works by downloading the file
from the specified URL. The file must be a valid Taskfile and can be of any from the specified URL. The file must be a valid Taskfile and can be of any
@@ -66,7 +66,7 @@ find a valid Taskfile, an error is returned.
### Git over HTTP ### Git over HTTP
`https://github.com/go-task/task.git//website/static/Taskfile.yml?ref=main` `https://github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main`
This type of node works by downloading the file from a Git repository over This type of node works by downloading the file from a Git repository over
HTTP/HTTPS. The first part of the URL is the base URL of the Git repository. HTTP/HTTPS. The first part of the URL is the base URL of the Git repository.
@@ -80,7 +80,7 @@ This is the same URL that you would use to clone the repo over HTTP.
### Git over SSH ### Git over SSH
`git@github.com/go-task/task.git//website/static/Taskfile.yml?ref=main` `git@github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main`
This type of node works by downloading the file from a Git repository over SSH. This type of node works by downloading the file from a Git repository over SSH.
The first part of the URL is the user and base URL of the Git repository. This The first part of the URL is the user and base URL of the Git repository. This
@@ -121,19 +121,19 @@ file. For example:
::: code-group ::: code-group
```shell [HTTP/HTTPS] ```shell [HTTP/HTTPS]
$ task --taskfile https://raw.githubusercontent.com/go-task/task/main/website/static/Taskfile.yml $ task --taskfile https://raw.githubusercontent.com/go-task/task/main/website/src/public/Taskfile.yml
task: [hello] echo "Hello Task!" task: [hello] echo "Hello Task!"
Hello Task! Hello Task!
``` ```
```shell [Git over HTTP] ```shell [Git over HTTP]
$ task --taskfile https://github.com/go-task/task.git//website/static/Taskfile.yml?ref=main $ task --taskfile https://github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main
task: [hello] echo "Hello Task!" task: [hello] echo "Hello Task!"
Hello Task! Hello Task!
``` ```
```shell [Git over SSH] ```shell [Git over SSH]
$ task --taskfile git@github.com/go-task/task.git//website/static/Taskfile.yml?ref=main $ task --taskfile git@github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main
task: [hello] echo "Hello Task!" task: [hello] echo "Hello Task!"
Hello Task! Hello Task!
``` ```
@@ -152,21 +152,21 @@ the remote Taskfile will be available to run from your main Taskfile.
version: '3' version: '3'
includes: includes:
my-remote-namespace: https://raw.githubusercontent.com/go-task/task/main/website/static/Taskfile.yml my-remote-namespace: https://raw.githubusercontent.com/go-task/task/main/website/src/public/Taskfile.yml
``` ```
```yaml [Git over HTTP] ```yaml [Git over HTTP]
version: '3' version: '3'
includes: includes:
my-remote-namespace: https://github.com/go-task/task.git//website/static/Taskfile.yml?ref=main my-remote-namespace: https://github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main
``` ```
```yaml [Git over SSH] ```yaml [Git over SSH]
version: '3' version: '3'
includes: includes:
my-remote-namespace: git@github.com/go-task/task.git//website/static/Taskfile.yml?ref=main my-remote-namespace: git@github.com/go-task/task.git//website/src/public/Taskfile.yml?ref=main
``` ```
::: :::
@@ -292,7 +292,9 @@ the `--download` flag.
You can use the `--clear-cache` flag to clear all cached remote files. You can use the `--clear-cache` flag to clear all cached remote files.
## Configuration ## Configuration
This experiment adds a new `remote` section to the [configuration file](../reference/config.md).
This experiment adds a new `remote` section to the
[configuration file](../reference/config.md).
- **Type**: `object` - **Type**: `object`
- **Description**: Remote configuration settings for handling remote Taskfiles - **Description**: Remote configuration settings for handling remote Taskfiles
@@ -344,10 +346,10 @@ remote:
- **Type**: `string` - **Type**: `string`
- **Default**: 0s (no cache) - **Default**: 0s (no cache)
- **Pattern**: `^[0-9]+(ns|us|µs|ms|s|m|h)$` - **Pattern**: `^[0-9]+(ns|us|µs|ms|s|m|h)$`
- **Description**: Cache expiry duration for remote Taskfiles (e.g., '1h', '24h') - **Description**: Cache expiry duration for remote Taskfiles (e.g., '1h',
'24h')
```yaml ```yaml
remote: remote:
cache-expiry: "6h" cache-expiry: "6h"
``` ```

2
website/src/docs/integrations.md
View File

@@ -35,7 +35,7 @@ To get autocompletion and validation for your Taskfile, see the
This was initially created by @KROSF in This was initially created by @KROSF in
[this Gist](https://gist.github.com/KROSF/c5435acf590acd632f71bb720f685895) and [this Gist](https://gist.github.com/KROSF/c5435acf590acd632f71bb720f685895) and
is now officially maintained in is now officially maintained in
[this file](https://github.com/go-task/task/blob/main/website/static/schema.json) [this file](https://github.com/go-task/task/blob/main/website/src/public/schema.json)
and made available at https://taskfile.dev/schema.json. This schema can be used and made available at https://taskfile.dev/schema.json. This schema can be used
to validate Taskfiles and provide autocompletion in many code editors: to validate Taskfiles and provide autocompletion in many code editors: