Skip to content

Commit 1979455

Browse files
authored
docs: improve description of action inputs (#321)
1 parent a17bbee commit 1979455

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Dependency directory
22
node_modules
3+
package-lock.json
34

45
# Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
56
# Logs

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,12 +120,14 @@ jobs:
120120

121121
### Inputs
122122

123-
- `surge_token`: [Getting your Surge token](https://surge.sh/help/integrating-with-circleci).
124-
- `github_token`: Defaults: [`github.token`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow). It is used to create Pull Request comment, so it requires the `pull-requests` permission set to `write` permission. Possible value: `secrets.GITHUB_TOKEN`.
125-
- `build`: build scripts to run before deploy.
126-
- `dist`: dist folder deployed to [surge.sh](https://surge.sh/).
127-
- `failOnError`: Set `failed` if a deployment throws error, defaults to `false`.
128-
- `teardown`: Determines if the preview instance will be torn down on PR close, defaults to `false`.
123+
| Parameter | Description | Default |
124+
|-----------------|-----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
125+
| `surge_token` | [Getting your Surge token](https://surge.sh/help/integrating-with-circleci). | An arbitrary token for demonstration. Use your own, otherwise anybody using this action can control your surge domain. |
126+
| `github_token` | Used to create Pull Request comment, requires `pull-requests` permission set to `write`. Possible value: `secrets.GITHUB_TOKEN`. | [`github.token`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow) |
127+
| `build` | Build scripts to run before deploy. | `npm install` <br> `npm run build` |
128+
| `dist` | Dist folder deployed to [surge.sh](https://surge.sh/). | `public` |
129+
| `failOnError` | Set `failed` if a deployment throws error. If not set, fallback to the `FAIL_ON__ERROR` environment variable. | `false` |
130+
| `teardown` | Determines if the preview instance will be torn down on PR close. | `false` |
129131

130132
### Outputs
131133

0 commit comments

Comments
 (0)