From 51dbbe182b9ba44b418f79abb274cdb38a31eb80 Mon Sep 17 00:00:00 2001 From: tooomm Date: Thu, 7 Jul 2022 19:01:46 +0200 Subject: [PATCH 1/5] add examples to arguments table --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4dc5e9a..146791d 100644 --- a/README.md +++ b/README.md @@ -83,15 +83,15 @@ See [lychee's documentation][lychee-args] for all possible arguments. On top of that, the action also supports some additional arguments. -| Argument | Description | -| ------------- | -------------------------------------------------------------------------------- | -| format | Summary output format (markdown, json,...) | -| output | Summary output file path | -| fail | Fail entire pipeline on error (i.e. when lychee exit code is not 0) | -| jobSummary | Write Github job summary at the end of the job (written on Markdown output only) | -| lycheeVersion | Overwrite the lychee version to be used | +| Argument | Examples | Description | +| ------------- | ------------------ |--------------------------------------------------------------------------------- | +| format | `markdown`, `json` | Summary output format | +| output | *file path* | Summary output file path | +| fail | `true` | Fail entire pipeline on error (i.e. when lychee exit code is not 0) | +| jobSummary | `true` | Write Github job summary at the end of the job (written on Markdown output only) | +| lycheeVersion | `0.10.0` | Overwrite the lychee version to be used | -See [action.yml](./action.yml) for a full list of supported arguments. +See [action.yml](./action.yml) for a full list of supported arguments and their default values. ### Example of argument passing @@ -196,4 +196,4 @@ at your option. [lychee-args]: https://github.com/lycheeverse/lychee#commandline-parameters [troubleshooting]: https://github.com/lycheeverse/lychee/blob/master/docs/TROUBLESHOOTING.md [security]: https://francoisbest.com/posts/2020/the-security-of-github-actions -[dependabot]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file \ No newline at end of file +[dependabot]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file From a8f6f58367554568b1541986fa2a1e7b067e8987 Mon Sep 17 00:00:00 2001 From: tooomm Date: Thu, 7 Jul 2022 19:10:35 +0200 Subject: [PATCH 2/5] expand on table --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 146791d..8312bfd 100644 --- a/README.md +++ b/README.md @@ -79,17 +79,17 @@ jobs: This action uses [lychee] for link checking. lychee arguments can be passed to the action via the `args` parameter. -See [lychee's documentation][lychee-args] for all possible arguments. On top of that, the action also supports some additional arguments. -| Argument | Examples | Description | -| ------------- | ------------------ |--------------------------------------------------------------------------------- | -| format | `markdown`, `json` | Summary output format | -| output | *file path* | Summary output file path | -| fail | `true` | Fail entire pipeline on error (i.e. when lychee exit code is not 0) | -| jobSummary | `true` | Write Github job summary at the end of the job (written on Markdown output only) | -| lycheeVersion | `0.10.0` | Overwrite the lychee version to be used | +| Argument | Examples | Description | +| ------------- | ---------------------------- |--------------------------------------------------------------------------------- | +| args | `--cache`, `--require-https` | See [lychee's documentation][lychee-args] for all possible arguments and values | +| format | `markdown`, `json` | Summary output format | +| output | `lychee/results.md` | Summary output file path | +| fail | `true` | Fail entire pipeline on error (i.e. when lychee exit code is not 0) | +| jobSummary | `true` | Write Github job summary at the end of the job (written on Markdown output only) | +| lycheeVersion | `0.10.0` | Overwrite the lychee version to be used | See [action.yml](./action.yml) for a full list of supported arguments and their default values. From 219d870736c96826f2a755c978443864e8d0332e Mon Sep 17 00:00:00 2001 From: tooomm Date: Thu, 7 Jul 2022 19:20:21 +0200 Subject: [PATCH 3/5] more narrow examples column to prevent wrapping --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8312bfd..eb28694 100644 --- a/README.md +++ b/README.md @@ -82,14 +82,14 @@ lychee arguments can be passed to the action via the `args` parameter. On top of that, the action also supports some additional arguments. -| Argument | Examples | Description | -| ------------- | ---------------------------- |--------------------------------------------------------------------------------- | -| args | `--cache`, `--require-https` | See [lychee's documentation][lychee-args] for all possible arguments and values | -| format | `markdown`, `json` | Summary output format | -| output | `lychee/results.md` | Summary output file path | -| fail | `true` | Fail entire pipeline on error (i.e. when lychee exit code is not 0) | -| jobSummary | `true` | Write Github job summary at the end of the job (written on Markdown output only) | -| lycheeVersion | `0.10.0` | Overwrite the lychee version to be used | +| Argument | Examples | Description | +| ------------- | ----------------------- |--------------------------------------------------------------------------------- | +| args | `--cache`, `--insecure` | See [lychee's documentation][lychee-args] for all possible arguments and values | +| format | `markdown`, `json` | Summary output format | +| output | `lychee/results.md` | Summary output file path | +| fail | `true` | Fail entire pipeline on error (i.e. when lychee exit code is not 0) | +| jobSummary | `true` | Write Github job summary at the end of the job (written on Markdown output only) | +| lycheeVersion | `0.10.0` | Overwrite the lychee version to be used | See [action.yml](./action.yml) for a full list of supported arguments and their default values. From befa682d81e289f5db605f49dde7d27e081bb361 Mon Sep 17 00:00:00 2001 From: tooomm Date: Thu, 7 Jul 2022 19:26:03 +0200 Subject: [PATCH 4/5] table wording --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index eb28694..60e4b3f 100644 --- a/README.md +++ b/README.md @@ -82,14 +82,14 @@ lychee arguments can be passed to the action via the `args` parameter. On top of that, the action also supports some additional arguments. -| Argument | Examples | Description | -| ------------- | ----------------------- |--------------------------------------------------------------------------------- | -| args | `--cache`, `--insecure` | See [lychee's documentation][lychee-args] for all possible arguments and values | -| format | `markdown`, `json` | Summary output format | -| output | `lychee/results.md` | Summary output file path | -| fail | `true` | Fail entire pipeline on error (i.e. when lychee exit code is not 0) | -| jobSummary | `true` | Write Github job summary at the end of the job (written on Markdown output only) | -| lycheeVersion | `0.10.0` | Overwrite the lychee version to be used | +| Argument | Examples | Description | +| ------------- | ----------------------- |------------------------------------------------------------------------- | +| args | `--cache`, `--insecure` | See [lychee's documentation][lychee-args] for all arguments and values | +| format | `markdown`, `json` | Summary output format | +| output | `lychee/results.md` | Summary output file path | +| fail | `false` | Fail workflow run on error (i.e. when lychee exit code is not 0) | +| jobSummary | `false` | Write Github job summary (on Markdown output only) | +| lycheeVersion | `0.10.0` | Overwrite the lychee version to be used | See [action.yml](./action.yml) for a full list of supported arguments and their default values. From f820526e63fd4da65229aa2ee2f631419f17a813 Mon Sep 17 00:00:00 2001 From: tooomm Date: Thu, 7 Jul 2022 19:36:02 +0200 Subject: [PATCH 5/5] add link to exit codes --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 60e4b3f..bf89fe9 100644 --- a/README.md +++ b/README.md @@ -82,14 +82,14 @@ lychee arguments can be passed to the action via the `args` parameter. On top of that, the action also supports some additional arguments. -| Argument | Examples | Description | -| ------------- | ----------------------- |------------------------------------------------------------------------- | -| args | `--cache`, `--insecure` | See [lychee's documentation][lychee-args] for all arguments and values | -| format | `markdown`, `json` | Summary output format | -| output | `lychee/results.md` | Summary output file path | -| fail | `false` | Fail workflow run on error (i.e. when lychee exit code is not 0) | -| jobSummary | `false` | Write Github job summary (on Markdown output only) | -| lycheeVersion | `0.10.0` | Overwrite the lychee version to be used | +| Argument | Examples | Description | +| ------------- | ----------------------- |-------------------------------------------------------------------------------- | +| args | `--cache`, `--insecure` | See [lychee's documentation][lychee-args] for all arguments and values | +| format | `markdown`, `json` | Summary output format | +| output | `lychee/results.md` | Summary output file path | +| fail | `false` | Fail workflow run on error (i.e. when [lychee exit code][lychee-exit] is not 0) | +| jobSummary | `false` | Write Github job summary (on Markdown output only) | +| lycheeVersion | `0.10.0` | Overwrite the lychee version to be used | See [action.yml](./action.yml) for a full list of supported arguments and their default values. @@ -194,6 +194,7 @@ at your option. [lychee]: https://github.com/lycheeverse/lychee [lychee-args]: https://github.com/lycheeverse/lychee#commandline-parameters +[lychee-exit]: https://github.com/lycheeverse/lychee#exit-codes [troubleshooting]: https://github.com/lycheeverse/lychee/blob/master/docs/TROUBLESHOOTING.md [security]: https://francoisbest.com/posts/2020/the-security-of-github-actions [dependabot]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file