Skip to content

Commit

Permalink
doc: Update README and action.yml
Browse files Browse the repository at this point in the history
Marks `command` and `stack-name` as optional.
Updates guidance in README about install-only mode.
  • Loading branch information
abhinav committed Mar 8, 2023
1 parent 05e0f82 commit b6a5df2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
23 changes: 14 additions & 9 deletions README.md
Expand Up @@ -34,13 +34,14 @@ This will check out the existing directory and run `pulumi preview`.

The action can be configured with the following arguments:

- `command` (required) - The command to run as part of the action. Accepted
values are `up` (alias: update), `refresh`, `destroy`, `install`, and
`preview`.
- `command` (optional) - The command to run as part of the action. Accepted
values are `up` (alias: update), `refresh`, `destroy`, and `preview`. If
unspecified, the action will stop after installing Pulumi.

- `stack-name` (required) - The name of the stack that Pulumi will be operating
- `stack-name` (optional) - The name of the stack that Pulumi will be operating
on. Use the fully quaified org-name/stack-name when operating on a stack
outside of your individual account.
outside of your individual account. This field is required if a `command` was
specified.

- `work-dir` (optional) - The location of your Pulumi files. Defaults to `./`.

Expand Down Expand Up @@ -127,10 +128,14 @@ the `cloud-url` argument.

### Installation Only

Unlike the other possible commands, the `install` command does not directly
correspond to a CLI subcommand of the `pulumi` binary. Instead, workflow steps
that provide `command: install` will install the Pulumi CLI and exit without
performing any other operations.
If you want to only install the Pulumi CLI, omit the `command` field of the
action.

```yaml
- uses: pulumi/actions@v4
```

This will install Pulumi and exit without performing any other operations.

### Stack Outputs

Expand Down
4 changes: 2 additions & 2 deletions action.yml
Expand Up @@ -7,10 +7,10 @@ branding:
inputs:
command:
description: 'Pulumi command to run, eg. up'
required: true
required: false
stack-name:
description: 'Which stack you want to apply to, eg. dev'
required: true
required: false
work-dir:
description: 'Location of your Pulumi files. Defaults to ./'
required: false
Expand Down

0 comments on commit b6a5df2

Please sign in to comment.