kukiron/wait-for-netlify-deploy

A GitHub action that will wait until a Netlify Preview deploy has completed before continuing on

Netlify Deploy Completion — A GitHub Action ⏱

Do you have other Github actions (Lighthouse, Cypress, etc) that depend on the Netlify Preview URL? This action will wait until the url is available before running the next task.

This is a fork of JakePartusch/wait-for-netlify-action which only works for pull_request. This works for push action as well with pr_number as input from previous step.

You will need to generate a Personal access token to use and pass it as the NETLIFY_AUTH_TOKEN environment variable.

Inputs

site_name

Required — The name of the Netlify site to reach https://{site_name}.netlify.app

pr_number

Required — For e2e_tests branch, the PR number coming from the previous step (using jwalton/gh-find-current-pr@v1 action). For master branch, use PR number from GitHub event.

request_headers

Optional — Stringified HTTP Header object key/value pairs to send in requests (e.g - '{ "Authorization": "Basic YWxhZGRpbjpvcGVuc2VzYW1l }')

max_timeout

Optional — The amount of time to spend waiting on Netlify. Defaults to 60 seconds

base_path

Optional — The page that needs to be tested for 200. Defaults to "/" (eg: https://{site_name}.netlify.app{base_path})

Outputs

url

The netlify deploy preview url that was deployed.

Usage

steps:
  - name: Wait for Netlify Deploy
    uses: kukiron/wait-for-netlify-deploy@v1.2.1
    id: waitForDeployment
    with:
      site_name: ${{ secrets.NETLIFY_SITE_NAME }}
      # pr_number: ${{ steps.findPR.outputs.pr }} # use for `e2e_tests` branch
      # pr_number: ${{ github.event.pull_request.number }} # use for `master` branch
      max_timeout: 300
    env:
      NETLIFY_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}