mirrored-actions/dagger-for-github
1
0
Fork 0
mirror of https://github.com/dagger/dagger-for-github.git synced 2026-01-01 21:19:44 +11:00
Code Issues Projects Releases Packages Wiki Activity

docs: Update README with examples & inputs

Browse source 
Signed-off-by: Jeremy Adams <jeremy@dagger.io>
This commit is contained in:
Jeremy Adams 2023-11-14 11:04:42 -08:00
parent 106340bff2
commit 0e89f4742a
1 changed files with 26 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -1,25 +1,41 @@
# dagger-for-github # GitHub action to run Dagger
Github action to run Dagger ## Usage Examples
### `dagger call` (default)
```yaml ```yaml
- name: Dagger - name: Hello
uses: dagger/dagger-for-github@v5 uses: dagger/dagger-for-github@v5
with: with:
module: github.com/kpenfound/greetings-api/ci verb: call
args: ci --commit $GITHUB_SHA module: github.com/shykes/daggerverse/hello
args: with-greeting --greeting Hola with-name --name Jeremy message
cloud-token: ${{ secrets.DAGGER_CLOUD_TOKEN }} cloud-token: ${{ secrets.DAGGER_CLOUD_TOKEN }}
``` ```
or with more options: ### `dagger run`
```yaml ```yaml
- name: Dagger - name: Integration Test
uses: dagger/dagger-for-github@v5 uses: dagger/dagger-for-github@v5
with: with:
module: github.com/kpenfound/greetings-api/ci workdir: db-service
args: ci --commit $GITHUB_SHA verb: run
args: node build.js
cloud-token: ${{ secrets.DAGGER_CLOUD_TOKEN }} cloud-token: ${{ secrets.DAGGER_CLOUD_TOKEN }}
version: "0.9.3" version: "0.9.3"
verb: call
``` ```
### All `with:` input parameter options
| Key | Description | Required | Default |
|---------------|-------------------------------------------------------------|----------|---------------------|
| `version` | Dagger Version | false | '0.9.3' |
| `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 | '' |