Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@deemp
deemp committed Feb 4, 2024
1 parent 920d3a6 commit fc330c4
Showing 1 changed file with 40 additions and 44 deletions.
84 changes: 40 additions & 44 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,58 +63,54 @@ jobs:
```

<!-- action-docs-inputs action="action.yml" -->

## Inputs

| name | description | required | default |
| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------- |
| `working-directory` | <p>Working directory for run commands</p> | `false` | `.` |
| `stack-yaml` | <p>Override stack.yaml, relative to working-directory</p> | `false` | `stack.yaml` |
| `test` | <p>Whether to run tests</p> | `false` | `true` |
| `stack-arguments` | <p>Additional arguments for all top-level <code>stack</code> command invocations.</p> | `false` | `--no-terminal` |
| `stack-query-arguments` | <p>Additional arguments in <code>stack query</code> invocations.</p> | `false` | `""` |
| `stack-path-arguments` | <p>Additional arguments in <code>stack path</code> invocations.</p> | `false` | `""` |
| `stack-setup-arguments` | <p>Additional arguments in <code>stack setup</code> invocations.</p> | `false` | `""` |
| `stack-build-arguments` | <p>Additional arguments for all <code>stack build</code> invocations.</p> | `false` | `--fast --pedantic` |
| `stack-build-arguments-dependencies` | <p>Additional arguments passed after <code>stack-build-arguments</code> in <code>stack build</code> invocations on the <em>Dependencies</em> step.</p> | `false` | `""` |
| `stack-build-arguments-build` | <p>Additional arguments passed after <code>stack-build-arguments</code> in <code>stack build</code> invocations on the <em>Build</em> step.</p> | `false` | `""` |
| `stack-build-arguments-test` | <p>Additional arguments passed after <code>stack-build-arguments</code> in <code>stack build</code> invocations on the <em>Test</em> step.</p> | `false` | `""` |
| `cache-prefix` | <p>Prefix applied to all cache keys. This can be any value you like, but teams often use <code>v{N}</code> and bump it to <code>v{N+1}</code> when/if they need to explicitly bust caches.</p> | `false` | `""` |
| `cache-save-always` | <p>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 <code>@v4.2.0</code></p> | `false` | `false` |

| name | description | required | default |
| --- | --- | --- | --- |
| `working-directory` | <p>Working directory for run commands</p> | `false` | `.` |
| `stack-yaml` | <p>Override stack.yaml, relative to working-directory</p> | `false` | `stack.yaml` |
| `test` | <p>Whether to run tests</p> | `false` | `true` |
| `stack-arguments` | <p>Additional arguments for all top-level <code>stack</code> command invocations.</p> | `false` | `--no-terminal` |
| `stack-query-arguments` | <p>Additional arguments in <code>stack query</code> invocations.</p> | `false` | `""` |
| `stack-path-arguments` | <p>Additional arguments in <code>stack path</code> invocations.</p> | `false` | `""` |
| `stack-setup-arguments` | <p>Additional arguments in <code>stack setup</code> invocations.</p> | `false` | `""` |
| `stack-build-arguments` | <p>Additional arguments for all <code>stack build</code> invocations.</p> | `false` | `--fast --pedantic` |
| `stack-build-arguments-dependencies` | <p>Additional arguments passed after <code>stack-build-arguments</code> in <code>stack build</code> invocations on the <em>Dependencies</em> step.</p> | `false` | `""` |
| `stack-build-arguments-build` | <p>Additional arguments passed after <code>stack-build-arguments</code> in <code>stack build</code> invocations on the <em>Build</em> step.</p> | `false` | `""` |
| `stack-build-arguments-test` | <p>Additional arguments passed after <code>stack-build-arguments</code> in <code>stack build</code> invocations on the <em>Test</em> step.</p> | `false` | `""` |
| `cache-prefix` | <p>Prefix applied to all cache keys. This can be any value you like, but teams often use <code>v{N}</code> and bump it to <code>v{N+1}</code> when/if they need to explicitly bust caches.</p> | `false` | `""` |
| `cache-save-always` | <p>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 <code>@v4.2.0</code></p> | `false` | `false` |
<!-- action-docs-inputs action="action.yml" -->

<!-- action-docs-outputs action="action.yml" -->

## Outputs

| name | description |
| ----------------------- | ---------------------------------------------------------------------------- |
| `compiler` | <p><code>compiler.actual</code> value from stack query</p> |
| `compiler-version` | <p>The GHC version part of compiler</p> |
| `snapshot-doc-root` | <p><code>snapshot-doc-root</code> value from <code>stack path</code></p> |
| `local-doc-root` | <p><code>local-doc-root</code> value from <code>stack path</code></p> |
| `local-hoogle-root` | <p><code>local-hoogle-root</code> value from <code>stack path</code></p> |
| `stack-root` | <p><code>stack-root</code> value from <code>stack path</code></p> |
| `project-root` | <p><code>project-root</code> value from <code>stack path</code></p> |
| `config-location` | <p><code>config-location</code> value from <code>stack path</code></p> |
| `bin-path` | <p><code>bin-path</code> value from <code>stack path</code></p> |
| `programs` | <p><code>programs</code> value from <code>stack path</code></p> |
| `compiler-exe` | <p><code>compiler-exe</code> value from <code>stack path</code></p> |
| `compiler-bin` | <p><code>compiler-bin</code> value from <code>stack path</code></p> |
| `compiler-tools-bin` | <p><code>compiler-tools-bin</code> value from <code>stack path</code></p> |
| `local-bin` | <p><code>local-bin</code> value from <code>stack path</code></p> |
| `extra-include-dirs` | <p><code>extra-include-dirs</code> value from <code>stack path</code></p> |
| `extra-library-dirs` | <p><code>extra-library-dirs</code> value from <code>stack path</code></p> |
| `snapshot-pkg-db` | <p><code>snapshot-pkg-db</code> value from <code>stack path</code></p> |
| `local-pkg-db` | <p><code>local-pkg-db</code> value from <code>stack path</code></p> |
| `global-pkg-db` | <p><code>global-pkg-db</code> value from <code>stack path</code></p> |
| `ghc-package-path` | <p><code>ghc-package-path</code> value from <code>stack path</code></p> |
| name | description |
| --- | --- |
| `compiler` | <p><code>compiler.actual</code> value from stack query</p> |
| `compiler-version` | <p>The GHC version part of compiler</p> |
| `snapshot-doc-root` | <p><code>snapshot-doc-root</code> value from <code>stack path</code></p> |
| `local-doc-root` | <p><code>local-doc-root</code> value from <code>stack path</code></p> |
| `local-hoogle-root` | <p><code>local-hoogle-root</code> value from <code>stack path</code></p> |
| `stack-root` | <p><code>stack-root</code> value from <code>stack path</code></p> |
| `project-root` | <p><code>project-root</code> value from <code>stack path</code></p> |
| `config-location` | <p><code>config-location</code> value from <code>stack path</code></p> |
| `bin-path` | <p><code>bin-path</code> value from <code>stack path</code></p> |
| `programs` | <p><code>programs</code> value from <code>stack path</code></p> |
| `compiler-exe` | <p><code>compiler-exe</code> value from <code>stack path</code></p> |
| `compiler-bin` | <p><code>compiler-bin</code> value from <code>stack path</code></p> |
| `compiler-tools-bin` | <p><code>compiler-tools-bin</code> value from <code>stack path</code></p> |
| `local-bin` | <p><code>local-bin</code> value from <code>stack path</code></p> |
| `extra-include-dirs` | <p><code>extra-include-dirs</code> value from <code>stack path</code></p> |
| `extra-library-dirs` | <p><code>extra-library-dirs</code> value from <code>stack path</code></p> |
| `snapshot-pkg-db` | <p><code>snapshot-pkg-db</code> value from <code>stack path</code></p> |
| `local-pkg-db` | <p><code>local-pkg-db</code> value from <code>stack path</code></p> |
| `global-pkg-db` | <p><code>global-pkg-db</code> value from <code>stack path</code></p> |
| `ghc-package-path` | <p><code>ghc-package-path</code> value from <code>stack path</code></p> |
| `snapshot-install-root` | <p><code>snapshot-install-root</code> value from <code>stack path</code></p> |
| `local-install-root` | <p><code>local-install-root</code> value from <code>stack path</code></p> |
| `dist-dir` | <p><code>dist-dir</code> value from <code>stack path</code></p> |
| `local-hpc-root` | <p><code>local-hpc-root</code> value from <code>stack path</code></p> |

| `local-install-root` | <p><code>local-install-root</code> value from <code>stack path</code></p> |
| `dist-dir` | <p><code>dist-dir</code> value from <code>stack path</code></p> |
| `local-hpc-root` | <p><code>local-hpc-root</code> value from <code>stack path</code></p> |
<!-- action-docs-outputs action="action.yml" -->

## Generating a Build Matrix of `stack.yaml`s
Expand Down

0 comments on commit fc330c4

Please sign in to comment.