From d40760b1bba23469cb0abbf2e428d8cac6d6832a Mon Sep 17 00:00:00 2001 From: Danila Danko Date: Tue, 30 Jan 2024 23:41:38 +0300 Subject: [PATCH] chore: update readme --- README.md | 53 +---------------------------------------------------- 1 file changed, 1 insertion(+), 52 deletions(-) diff --git a/README.md b/README.md index 630cb66..184a4cb 100644 --- a/README.md +++ b/README.md @@ -58,58 +58,7 @@ jobs: ## Inputs -All inputs are optional. - -- `working-directory`: working directory for all `run` steps. - - Default is `.`. Useful for a multi-project repository. - -- `stack-yaml`: path to use instead of `stack.yaml`. - - Default is `stack.yaml`. Expected to be relative to `working-directory`. - -- `test`: whether tests should be executed - - Default `true`. - -- `stack-arguments`: global arguments for **all** `stack` invocations - - Default is `--no-terminal --stack-yaml {stack-yaml}`, and if `stack-yaml` is - the string `"stack-nightly.yaml"`, `--resolver nightly` will be added. - -- `stack-build-arguments`: arguments for **all** `stack build` invocations - - Default is `--fast --pedantic`. If you are building executables, you probably - want to override this to remove `--fast`. - -- `stack-build-arguments-dependencies`: additional arguments for `stack build` - in the _Dependencies_ step. - -- `stack-build-arguments-build`: additional arguments for `stack build` in the - _Build_ step. - -- `stack-build-arguments-test`: additional arguments for `stack build` in the - _Test_ step. - -- `stack-setup-arguments`: additional arguments for `stack setup` - - Default is none. - -- `stack-query-arguments`: additional arguments for `stack query` - - Default is none. - -- `stack-path-arguments`: additional arguments for `stack path` - - Default is none. - -- `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. The default is empty. - -- `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`) +
name description default required

working-directory

Working directory for run commands

.

true

stack-yaml

Override stack.yaml, relative to working-directory

stack.yaml

true

test

Whether to run tests

true

false

stack-arguments

Additional arguments for all top-level stack command invocations.

--no-terminal

true

stack-query-arguments

Additional arguments in stack query invocations.

""

true

stack-path-arguments

Additional arguments in stack path invocations.

""

true

stack-setup-arguments

Additional arguments in stack setup invocations.

""

true

stack-build-arguments

Additional arguments for all stack build invocations.

--fast --pedantic

true

stack-build-arguments-dependencies

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

""

true

stack-build-arguments-build

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

""

true

stack-build-arguments-test

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

""

true

cache-prefix

Cache prefix

""

true

cache-save-always

Save the dependencies and build cache even if a build fails

false

false

## Outputs