Skip to content

Commit

Permalink
docs: add inputs.fail_when_cancelled & outputs.status to README (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
thundermiracle authored Aug 3, 2022
1 parent 0fed407 commit b807ac4
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,13 @@ jobs:
| alias_template | ○ | | Your alias URL template. eg: (`hello.mysite.com`) or (`{random}.e2e-test.mysite.com`) |
| token | | `github.token` | Github Personal Access Token deployment |
| interval | | `10000 (ms)` | waiting interval while deployment is not finished in milliseconds |
| fail_when_cancelled | | `true` | Fail CI when deployment status is `CANCELED` |

| `outputs` | description |
| :------------------- | :--------------------------------------- |
| `preview_url_alias` | Alias of Vercel's Deployment Preview URL |
| `preview_url_origin` | Original Vercel's Deployment Preview URL |
| `outputs` | description |
| :------------------- | :--------------------------------------------------- |
| `preview_url_alias` | Alias of Vercel's Deployment Preview URL |
| `preview_url_origin` | Original Vercel's Deployment Preview URL |
| `status` | `READY`, `ERROR`, `CANCELED`, `DEPLOYMENT_NOT_FOUND` |

## License

Expand Down

1 comment on commit b807ac4

@vercel
Copy link

@vercel vercel bot commented on b807ac4 Aug 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.