mirror of
https://github.com/dagger/dagger-for-github.git
synced 2026-01-02 21:29:47 +11:00
Merge pull request #49 from crazy-max/update-readme
chore: readme updates
This commit is contained in:
commit
a05f03361d
2 changed files with 16 additions and 9 deletions
13
README.md
13
README.md
|
|
@ -79,10 +79,17 @@ steps:
|
||||||
|
|
||||||
Following inputs can be used as `step.with` keys
|
Following inputs can be used as `step.with` keys
|
||||||
|
|
||||||
|
> `List` type is a newline-delimited string
|
||||||
|
> ```yaml
|
||||||
|
> cmds: |
|
||||||
|
> project update
|
||||||
|
> do test
|
||||||
|
> ```
|
||||||
|
|
||||||
| Name | Type | Default | Description |
|
| Name | Type | Default | Description |
|
||||||
|------------------|---------|--------------|------------------------------------------------------------------|
|
|------------------|--------|--------------|------------------------------------------------|
|
||||||
| `version` | String | `latest` | Dagger version |
|
| `version` | String | `latest` | Dagger version |
|
||||||
| `cmds` | String | | Commands to run on Dagger |
|
| `cmds` | List | | List of Dagger commands |
|
||||||
| `workdir` | String | `.` | Working directory (below repository root) |
|
| `workdir` | String | `.` | Working directory (below repository root) |
|
||||||
| `install-only` | Bool | `false` | Just install Dagger |
|
| `install-only` | Bool | `false` | Just install Dagger |
|
||||||
| `cleanup` | Bool | `true` | Cleanup Dagger home folder at the end of a job |
|
| `cleanup` | Bool | `true` | Cleanup Dagger home folder at the end of a job |
|
||||||
|
|
@ -102,4 +109,4 @@ docker buildx bake test
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT. See `LICENSE` for more details.
|
Apache-2.0 License. See `LICENSE` for more details.
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,7 @@ inputs:
|
||||||
required: false
|
required: false
|
||||||
deprecationMessage: 'Use cmds input instead'
|
deprecationMessage: 'Use cmds input instead'
|
||||||
cmds:
|
cmds:
|
||||||
description: 'Commands to run on Dagger'
|
description: 'List of Dagger commands'
|
||||||
required: false
|
required: false
|
||||||
workdir:
|
workdir:
|
||||||
description: 'Working directory (below repository root)'
|
description: 'Working directory (below repository root)'
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue