From fc330c496645d073b3025ac9cc207d9d733d4cb1 Mon Sep 17 00:00:00 2001 From: Danila Danko Date: Sun, 4 Feb 2024 14:43:17 +0300 Subject: [PATCH] chore: update readme --- README.md | 84 ++++++++++++++++++++++++++----------------------------- 1 file changed, 40 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index dcededc..34ed71b 100644 --- a/README.md +++ b/README.md @@ -63,58 +63,54 @@ jobs: ``` - ## Inputs -| name | description | required | default | -| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------- | -| `working-directory` |

Working directory for run commands

| `false` | `.` | -| `stack-yaml` |

Override stack.yaml, relative to working-directory

| `false` | `stack.yaml` | -| `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` | - +| name | description | required | default | +| --- | --- | --- | --- | +| `working-directory` |

Working directory for run commands

| `false` | `.` | +| `stack-yaml` |

Override stack.yaml, relative to working-directory

| `false` | `stack.yaml` | +| `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` | - ## Outputs -| name | description | -| ----------------------- | ---------------------------------------------------------------------------- | -| `compiler` |

compiler.actual value from stack query

| -| `compiler-version` |

The GHC version part of compiler

| -| `snapshot-doc-root` |

snapshot-doc-root value from stack path

| -| `local-doc-root` |

local-doc-root value from stack path

| -| `local-hoogle-root` |

local-hoogle-root value from stack path

| -| `stack-root` |

stack-root value from stack path

| -| `project-root` |

project-root value from stack path

| -| `config-location` |

config-location value from stack path

| -| `bin-path` |

bin-path value from stack path

| -| `programs` |

programs value from stack path

| -| `compiler-exe` |

compiler-exe value from stack path

| -| `compiler-bin` |

compiler-bin value from stack path

| -| `compiler-tools-bin` |

compiler-tools-bin value from stack path

| -| `local-bin` |

local-bin value from stack path

| -| `extra-include-dirs` |

extra-include-dirs value from stack path

| -| `extra-library-dirs` |

extra-library-dirs value from stack path

| -| `snapshot-pkg-db` |

snapshot-pkg-db value from stack path

| -| `local-pkg-db` |

local-pkg-db value from stack path

| -| `global-pkg-db` |

global-pkg-db value from stack path

| -| `ghc-package-path` |

ghc-package-path value from stack path

| +| name | description | +| --- | --- | +| `compiler` |

compiler.actual value from stack query

| +| `compiler-version` |

The GHC version part of compiler

| +| `snapshot-doc-root` |

snapshot-doc-root value from stack path

| +| `local-doc-root` |

local-doc-root value from stack path

| +| `local-hoogle-root` |

local-hoogle-root value from stack path

| +| `stack-root` |

stack-root value from stack path

| +| `project-root` |

project-root value from stack path

| +| `config-location` |

config-location value from stack path

| +| `bin-path` |

bin-path value from stack path

| +| `programs` |

programs value from stack path

| +| `compiler-exe` |

compiler-exe value from stack path

| +| `compiler-bin` |

compiler-bin value from stack path

| +| `compiler-tools-bin` |

compiler-tools-bin value from stack path

| +| `local-bin` |

local-bin value from stack path

| +| `extra-include-dirs` |

extra-include-dirs value from stack path

| +| `extra-library-dirs` |

extra-library-dirs value from stack path

| +| `snapshot-pkg-db` |

snapshot-pkg-db value from stack path

| +| `local-pkg-db` |

local-pkg-db value from stack path

| +| `global-pkg-db` |

global-pkg-db value from stack path

| +| `ghc-package-path` |

ghc-package-path value from stack path

| | `snapshot-install-root` |

snapshot-install-root value from stack path

| -| `local-install-root` |

local-install-root value from stack path

| -| `dist-dir` |

dist-dir value from stack path

| -| `local-hpc-root` |

local-hpc-root value from stack path

| - +| `local-install-root` |

local-install-root value from stack path

| +| `dist-dir` |

dist-dir value from stack path

| +| `local-hpc-root` |

local-hpc-root value from stack path

| ## Generating a Build Matrix of `stack.yaml`s