diff --git a/website/docs/contributing.mdx b/website/docs/contributing.mdx index 88204553..2c820ffd 100644 --- a/website/docs/contributing.mdx +++ b/website/docs/contributing.mdx @@ -83,10 +83,10 @@ add a new section. If you're updating an existing feature, ensure that the documentation and any examples are up-to-date. Ensure that any examples follow the [Taskfile Styleguide](/styleguide). -If you added a new field, command or flag, ensure that you add it to the -[API Reference](/api). New fields also need to be added to the [JSON -Schema][json-schema]. The descriptions for fields in the API reference and the -schema should match. +If you added a new command or flag, ensure that you add it to the [CLI +Reference](/reference/cli). New fields also need to be added to the [Schema +Reference](/reference/schema) and [JSON Schema][json-schema]. The descriptions +for fields in the docs and the schema should match. ### Writing tests diff --git a/website/docs/reference/cli.mdx b/website/docs/reference/cli.mdx index 893236d1..e1963418 100644 --- a/website/docs/reference/cli.mdx +++ b/website/docs/reference/cli.mdx @@ -58,7 +58,7 @@ four groups with the following ranges: - Success (0) - General errors (1-99) - Taskfile errors (100-199) -- Task errors (200-299) +- Task errors (200-255) A full list of the exit codes and their descriptions can be found below: diff --git a/website/docs/usage.mdx b/website/docs/usage.mdx index aab62912..426dc300 100644 --- a/website/docs/usage.mdx +++ b/website/docs/usage.mdx @@ -938,8 +938,8 @@ information. You can use `--force` or `-f` if you want to force a task to run even when up-to-date. -Also, `task --status [tasks]...` will exit with a non-zero exit code if any of -the tasks are not up-to-date. +Also, `task --status [tasks]...` will exit with a non-zero [exit +code](/reference/cli#exit-codes) if any of the tasks are not up-to-date. `status` can be combined with the [fingerprinting](#by-fingerprinting-locally-generated-files-and-their-sources) @@ -1759,8 +1759,8 @@ commands are executed in the reverse order if you schedule multiple of them. ::: A special variable `.EXIT_CODE` is exposed when a command exited with a non-zero -exit code. You can check its presence to know if the task completed successfully -or not: +[exit code](/reference/cli#exit-codes). You can check its presence to know if +the task completed successfully or not: ```yaml version: '3' @@ -1959,8 +1959,8 @@ tasks: ``` Warning prompts are called before executing a task. If a prompt is denied Task -will exit with [exit code](/api#exit-codes) 205. If approved, Task will continue -as normal. +will exit with [exit code](/reference/cli#exit-codes) 205. If approved, Task +will continue as normal. ```shell ❯ task example diff --git a/website/versioned_docs/version-latest/contributing.mdx b/website/versioned_docs/version-latest/contributing.mdx index 88204553..2c820ffd 100644 --- a/website/versioned_docs/version-latest/contributing.mdx +++ b/website/versioned_docs/version-latest/contributing.mdx @@ -83,10 +83,10 @@ add a new section. If you're updating an existing feature, ensure that the documentation and any examples are up-to-date. Ensure that any examples follow the [Taskfile Styleguide](/styleguide). -If you added a new field, command or flag, ensure that you add it to the -[API Reference](/api). New fields also need to be added to the [JSON -Schema][json-schema]. The descriptions for fields in the API reference and the -schema should match. +If you added a new command or flag, ensure that you add it to the [CLI +Reference](/reference/cli). New fields also need to be added to the [Schema +Reference](/reference/schema) and [JSON Schema][json-schema]. The descriptions +for fields in the docs and the schema should match. ### Writing tests diff --git a/website/versioned_docs/version-latest/reference/cli.mdx b/website/versioned_docs/version-latest/reference/cli.mdx index 893236d1..e1963418 100644 --- a/website/versioned_docs/version-latest/reference/cli.mdx +++ b/website/versioned_docs/version-latest/reference/cli.mdx @@ -58,7 +58,7 @@ four groups with the following ranges: - Success (0) - General errors (1-99) - Taskfile errors (100-199) -- Task errors (200-299) +- Task errors (200-255) A full list of the exit codes and their descriptions can be found below: diff --git a/website/versioned_docs/version-latest/usage.mdx b/website/versioned_docs/version-latest/usage.mdx index aab62912..426dc300 100644 --- a/website/versioned_docs/version-latest/usage.mdx +++ b/website/versioned_docs/version-latest/usage.mdx @@ -938,8 +938,8 @@ information. You can use `--force` or `-f` if you want to force a task to run even when up-to-date. -Also, `task --status [tasks]...` will exit with a non-zero exit code if any of -the tasks are not up-to-date. +Also, `task --status [tasks]...` will exit with a non-zero [exit +code](/reference/cli#exit-codes) if any of the tasks are not up-to-date. `status` can be combined with the [fingerprinting](#by-fingerprinting-locally-generated-files-and-their-sources) @@ -1759,8 +1759,8 @@ commands are executed in the reverse order if you schedule multiple of them. ::: A special variable `.EXIT_CODE` is exposed when a command exited with a non-zero -exit code. You can check its presence to know if the task completed successfully -or not: +[exit code](/reference/cli#exit-codes). You can check its presence to know if +the task completed successfully or not: ```yaml version: '3' @@ -1959,8 +1959,8 @@ tasks: ``` Warning prompts are called before executing a task. If a prompt is denied Task -will exit with [exit code](/api#exit-codes) 205. If approved, Task will continue -as normal. +will exit with [exit code](/reference/cli#exit-codes) 205. If approved, Task +will continue as normal. ```shell ❯ task example