Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
clock

GitHub Action

Wait for Netlify

v1.0

Wait for Netlify

clock

Wait for Netlify

Wait for Netlify Deploy Preview to complete

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Wait for Netlify

uses: JakePartusch/[email protected]

Learn more about this action in JakePartusch/wait-for-netlify-action

Choose a version

Wait for Netlify — 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.

Inputs

site_name

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

max_timeout

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

Outputs

url

The netlify deploy preview url that was deployed.

Example usage

Basic Usage

steps:
  - name: Waiting for 200 from the Netlify Preview
    uses: jakepartusch/wait-for-netlify-action@v1
    id: waitFor200
    with:
      site_name: "jakepartusch"
      max_timeout: 60
Complete example with Lighthouse
name: Lighthouse

on: [pull_request]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v1
      - name: Use Node.js 12.x
        uses: actions/setup-node@v1
        with:
          node-version: 12.x
      - name: Install
        run: |
          npm ci
      - name: Build
        run: |
          npm run build
      - name: Waiting for 200 from the Netlify Preview
        uses: jakepartusch/wait-for-netlify-action@v1
        id: waitFor200
        with:
          site_name: "jakepartusch"
      - name: Lighthouse CI
        run: |
          npm install -g @lhci/[email protected]
          lhci autorun --upload.target=temporary-public-storage --collect.url=${{ steps.waitFor200.outputs.url }} || echo "LHCI failed!"
        env:
          LHCI_GITHUB_APP_TOKEN: ${{ secrets.LHCI_GITHUB_APP_TOKEN }}