From fcad2baa064df5f37f8aca806c32c622f1cfe989 Mon Sep 17 00:00:00 2001 From: patrick brisbin Date: Wed, 21 Feb 2024 08:51:43 -0500 Subject: [PATCH] Shorten stack-yaml description --- README.md | 32 ++++++++++++++++---------------- action.yml | 4 +--- 2 files changed, 17 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 0e8053a..b073850 100644 --- a/README.md +++ b/README.md @@ -66,22 +66,22 @@ jobs: ## Inputs -| name | description | required | default | -| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------- | -| `working-directory` |

Working directory for run commands

| `false` | `""` | -| `test` |

Whether to run tests

| `false` | `true` | -| `stack-arguments` |

Additional arguments for all top-level stack command invocations.

| `false` | `--no-terminal` | -| `stack-query-arguments` |

Additional arguments in stack query invocations.

| `false` | `""` | -| `stack-path-arguments` |

Additional arguments in stack path invocations.

| `false` | `""` | -| `stack-setup-arguments` |

Additional arguments in stack setup invocations.

| `false` | `""` | -| `stack-build-arguments` |

Additional arguments for all stack build invocations.

| `false` | `--fast --pedantic` | -| `stack-build-arguments-dependencies` |

Additional arguments passed after stack-build-arguments in stack build invocations on the Dependencies step.

| `false` | `""` | -| `stack-build-arguments-build` |

Additional arguments passed after stack-build-arguments in stack build invocations on the Build step.

| `false` | `""` | -| `stack-build-arguments-test` |

Additional arguments passed after stack-build-arguments in stack build invocations on the Test step.

| `false` | `""` | -| `cache-prefix` |

Prefix applied to all cache keys. This can be any value you like, but teams often use v{N} and bump it to v{N+1} when/if they need to explicitly bust caches.

| `false` | `""` | -| `cache-save-always` |

Save artifacts to the cache even if the build fails. This may speed up builds in subsequent runs at the expense of slightly-longer builds when a full cache-hit occurs. Since @v4.2.0

| `false` | `false` | -| `upgrade-stack` |

Upgrade stack

| `false` | `true` | -| `stack-yaml` |

This option is deprecated and will be removed in a future version, set env.STACK_YAML or use stack-arguments instead. For now, if present, --stack-yaml ... will be prepended to stack-arguments.

| `false` | `""` | +| name | description | required | default | +| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------- | +| `working-directory` |

Working directory for run commands

| `false` | `""` | +| `test` |

Whether to run tests

| `false` | `true` | +| `stack-arguments` |

Additional arguments for all top-level stack command invocations.

| `false` | `--no-terminal` | +| `stack-query-arguments` |

Additional arguments in stack query invocations.

| `false` | `""` | +| `stack-path-arguments` |

Additional arguments in stack path invocations.

| `false` | `""` | +| `stack-setup-arguments` |

Additional arguments in stack setup invocations.

| `false` | `""` | +| `stack-build-arguments` |

Additional arguments for all stack build invocations.

| `false` | `--fast --pedantic` | +| `stack-build-arguments-dependencies` |

Additional arguments passed after stack-build-arguments in stack build invocations on the Dependencies step.

| `false` | `""` | +| `stack-build-arguments-build` |

Additional arguments passed after stack-build-arguments in stack build invocations on the Build step.

| `false` | `""` | +| `stack-build-arguments-test` |

Additional arguments passed after stack-build-arguments in stack build invocations on the Test step.

| `false` | `""` | +| `cache-prefix` |

Prefix applied to all cache keys. This can be any value you like, but teams often use v{N} and bump it to v{N+1} when/if they need to explicitly bust caches.

| `false` | `""` | +| `cache-save-always` |

Save artifacts to the cache even if the build fails. This may speed up builds in subsequent runs at the expense of slightly-longer builds when a full cache-hit occurs. Since @v4.2.0

| `false` | `false` | +| `upgrade-stack` |

Upgrade stack

| `false` | `true` | +| `stack-yaml` |

Deprecated use env.STACK_YAML or stack-arguments instead.

| `false` | `""` | diff --git a/action.yml b/action.yml index 39bfa3f..a4676c9 100644 --- a/action.yml +++ b/action.yml @@ -54,9 +54,7 @@ inputs: default: true stack-yaml: description: | - **This option is deprecated** and will be removed in a future version, set - `env.STACK_YAML` or use `stack-arguments` instead. For now, if present, - `--stack-yaml ...` will be prepended to `stack-arguments`. + **Deprecated** use `env.STACK_YAML` or `stack-arguments` instead. runs: using: "node20" main: "dist/index.js"