Skip to content

Commit

Permalink
Update README and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
@pbrisbin
pbrisbin committed Feb 21, 2024
1 parent ea09173 commit 5a2b344
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 22 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/example.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,4 @@ jobs:
- uses: ./
with:
working-directory: example
stack-yaml: ${{ matrix.stack-yaml }}
stack-arguments: --stack-yaml ${{ matrix.stack-yaml }}
38 changes: 17 additions & 21 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@ jobs:
- uses: freckle/stack-action@v6
```
## Notable Changes in v6
The `stack-yaml` input has been removed. Users can either set `env.STACK_YAML`
or supply `--stack-yaml` via `inputs.stack-arguments` instead.

## Notable Changes in v5
As of version 5, the single `stack-arguments` input has been broken up into
Expand Down Expand Up @@ -71,21 +66,22 @@ jobs:

## Inputs

| name | description | required | default |
| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------- |
| `working-directory` | <p>Working directory for run commands</p> | `false` | `""` |
| `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` |
| `upgrade-stack` | <p>Upgrade stack</p> | `false` | `true` |
| name | description | required | default |
| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------- |
| `working-directory` | <p>Working directory for run commands</p> | `false` | `""` |
| `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` |
| `upgrade-stack` | <p>Upgrade stack</p> | `false` | `true` |
| `stack-yaml` | <p><strong>This option is deprecated</strong> and will be removed in a future version, set <code>env.STACK_YAML</code> or use <code>stack-arguments</code> instead. For now, if present, <code>--stack-yaml ...</code> will be prepended to <code>stack-arguments</code>.</p> | `false` | `""` |

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

Expand Down Expand Up @@ -146,7 +142,7 @@ jobs:
- uses: actions/checkout@v4
- uses: freckle/stack-action@v5
with:
stack-yaml: ${{ matrix.stack-yaml }}
stack-arguments: --stack-yaml ${{ matrix.stack-yaml }}
```

See [generate-matrix/action.yml](./generate-matrix/action.yml) for more details.
Expand Down
5 changes: 5 additions & 0 deletions action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ inputs:
description: |
Upgrade stack
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`.
runs:
using: "node20"
main: "dist/index.js"

0 comments on commit 5a2b344

Please sign in to comment.