Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patrickedqvist/wait-for-vercel-preview
A github action for waiting for the vercel preview
https://github.com/patrickedqvist/wait-for-vercel-preview
action actions vercel
Last synced: 3 days ago
JSON representation
A github action for waiting for the vercel preview
- Host: GitHub
- URL: https://github.com/patrickedqvist/wait-for-vercel-preview
- Owner: patrickedqvist
- License: mit
- Created: 2020-05-28T07:33:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T11:27:29.000Z (3 months ago)
- Last Synced: 2024-12-15T09:01:14.614Z (10 days ago)
- Topics: action, actions, vercel
- Language: JavaScript
- Homepage:
- Size: 10.4 MB
- Stars: 137
- Watchers: 2
- Forks: 52
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wait for Vercel Preview — A GitHub Action ⏱
Do you have other Github actions (Lighthouse, Cypress, etc) that depend on the Vercel Preview URL? This action will wait until the url is available before running the next task.
Please note that this action is supposed to be run on the `pull_request` or `push` events.
## Inputs
### `token` (Required)
The github secret `${{ secrets.GITHUB_TOKEN }}`
### `environment`
Optional — The name of the environment that was deployed to (e.g., staging or production)
### `max_timeout`
Optional — The amount of time to spend waiting on Vercel. Defaults to `60` seconds
### `allow_inactive`
Optional - Use the most recent inactive deployment (previously deployed preview) associated with the pull request if
no new deployment is available. Defaults to `false`.
### `check_interval`
Optional - How often (in seconds) should we make the HTTP request checking to see if the deployment is available? Defaults to `2` seconds.
### `vercel_password`
Optional - The [password](https://vercel.com/docs/concepts/projects/overview#password-protection) for the deployment
### `vercel_protection_bypass_header`
Optional - The [header](https://vercel.com/docs/security/deployment-protection/methods-to-bypass-deployment-protection/protection-bypass-automation) to bypass protection for automation
### `path`
Optional - The URL that tests should run against (eg. `path: "https://vercel.com"`).
## Outputs
### `url`
The vercel deploy preview url that was deployed.
### `vercel_jwt`
If accessing a password protected site, the JWT from the login event. This can be passed on to e2e tests, for instance.
## Example usage
Basic Usage
```yaml
steps:
- name: Waiting for 200 from the Vercel Preview
uses: patrickedqvist/[email protected]
id: waitFor200
with:
token: ${{ secrets.GITHUB_TOKEN }}
max_timeout: 60
# access preview url
- run: echo ${{steps.waitFor200.outputs.url}}
```
## Building
The Action is bundled via [ncc](https://github.com/vercel/ncc). See [this discussion](https://github.com/actions/hello-world-javascript-action/issues/12) for more information.
```sh
npm run build
# outputs the build to dist/index.js
```
## Tests
Unit tests with [Jest](https://jestjs.io/) and [Mock Service Worker](https://mswjs.io/)
```
npm test
```