mirror of
https://github.com/dagger/dagger-for-github.git
synced 2025-12-31 12:49:46 +11:00
46 lines
2 KiB
Markdown
46 lines
2 KiB
Markdown
# GitHub action to run Dagger
|
|
|
|
## Usage Examples
|
|
|
|
### `dagger call` (default)
|
|
|
|
```yaml
|
|
- name: Hello
|
|
uses: dagger/dagger-for-github@v6
|
|
with:
|
|
module: github.com/shykes/daggerverse/hello
|
|
call: hello --greeting Hola --name Jeremy
|
|
cloud-token: ${{ secrets.DAGGER_CLOUD_TOKEN }}
|
|
```
|
|
|
|
### `dagger run`
|
|
|
|
```yaml
|
|
- name: Integration Test
|
|
uses: dagger/dagger-for-github@v6
|
|
with:
|
|
workdir: db-service
|
|
verb: run
|
|
args: node build.js
|
|
cloud-token: ${{ secrets.DAGGER_CLOUD_TOKEN }}
|
|
version: "0.14.0"
|
|
```
|
|
|
|
### Staying in sync with the `latest` version
|
|
|
|
By setting the version to `latest`, this action will install the latest version of Dagger.
|
|
|
|
### All `with:` input parameter options
|
|
|
|
| Key | Description | Required | Default |
|
|
| -------------- | ----------------------------------------------------------- | -------- | ------------------ |
|
|
| `version` | Dagger Version | false | '0.14.0' |
|
|
| `commit` | Dagger Dev Commit (overrides `version`) | false | '' |
|
|
| `dagger-flags` | Dagger CLI Flags | false | '--progress plain' |
|
|
| `verb` | CLI verb (call, run, download, up, functions, shell, query) | false | 'call' |
|
|
| `workdir` | The working directory in which to run the Dagger CLI | false | '.' |
|
|
| `cloud-token` | Dagger Cloud Token | false | '' |
|
|
| `module` | Dagger module to call. Local or Git | false | '' |
|
|
| `args` | Arguments to pass to CLI | false | '' |
|
|
| `call` | Arguments to pass to CLI (Alias for args) | false | '' |
|
|
| `engine-stop` | Whether to stop the Dagger Engine after this run | false | 'true' |
|