From d07b9893c0418f3ee6c267cac413d78d934b1eec Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Wed, 13 Apr 2022 17:31:22 +0200 Subject: [PATCH] chore: update input section in readme Signed-off-by: CrazyMax --- README.md | 21 ++++++++++++++------- action.yml | 2 +- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9f27782..344c005 100644 --- a/README.md +++ b/README.md @@ -79,13 +79,20 @@ steps: Following inputs can be used as `step.with` keys -| Name | Type | Default | Description | -|------------------|---------|--------------|------------------------------------------------------------------| -| `version` | String | `latest` | Dagger version | -| `cmds` | String | | Commands to run on Dagger | -| `workdir` | String | `.` | Working directory (below repository root) | -| `install-only` | Bool | `false` | Just install Dagger | -| `cleanup` | Bool | `true` | Cleanup Dagger home folder at the end of a job | +> `List` type is a newline-delimited string +> ```yaml +> cmds: | +> project update +> do test +> ``` + +| Name | Type | Default | Description | +|------------------|--------|--------------|------------------------------------------------| +| `version` | String | `latest` | Dagger version | +| `cmds` | List | | List of Dagger commands | +| `workdir` | String | `.` | Working directory (below repository root) | +| `install-only` | Bool | `false` | Just install Dagger | +| `cleanup` | Bool | `true` | Cleanup Dagger home folder at the end of a job | ## Development diff --git a/action.yml b/action.yml index ded72b9..e4da945 100644 --- a/action.yml +++ b/action.yml @@ -15,7 +15,7 @@ inputs: required: false deprecationMessage: 'Use cmds input instead' cmds: - description: 'Commands to run on Dagger' + description: 'List of Dagger commands' required: false workdir: description: 'Working directory (below repository root)'