diff --git a/README.md b/README.md index adc01f9..557e259 100644 --- a/README.md +++ b/README.md @@ -66,23 +66,23 @@ 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` | -| `compiler-tools` |

A list of packages to install as compiler tools, one per line. This is useful to do here rather than separate run commands so that their installation is incorporated in the dependency cache.

| `false` | `""` | -| `stack-yaml` |

Deprecated use env.STACK_YAML or stack-arguments instead.

| `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` | +| `compiler-tools` |

A list of packages to install as compiler tools, one per line. This is useful to do here rather than separate run commands so that their installation is incorporated in the dependency cache. Since @v5.2.0.

| `false` | `""` | +| `stack-yaml` |

Deprecated use env.STACK_YAML or stack-arguments instead.

| `false` | `""` | @@ -117,7 +117,7 @@ jobs: ## Installing Compiler Tools -As of v5.2, the `compiler-tools` input can be used to install packages (with +The `compiler-tools` input can be used to install packages (with `--copy-compiler-tool`) as part of the _Dependencies_ step. The installed tools can be used by other parts of the build via `stack exec`, such as to reformat and upload coverage: diff --git a/action.yml b/action.yml index a26a6f6..80d4bb6 100644 --- a/action.yml +++ b/action.yml @@ -46,7 +46,7 @@ inputs: description: | 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` + full cache-hit occurs. Since `@v4.2.0`. default: false upgrade-stack: description: | @@ -56,7 +56,7 @@ inputs: description: | A list of packages to install as compiler tools, one per line. This is useful to do here rather than separate `run` commands so that their - installation is incorporated in the dependency cache. + installation is incorporated in the dependency cache. Since `@v5.2.0`. stack-yaml: description: | **Deprecated** use `env.STACK_YAML` or `stack-arguments` instead.