action.yml

name: Laravel Deploy Preview
description: Deploy PR preview sites for Laravel apps.
author: Jacob Baker-Kretzmar
inputs:
  forge-token:
    description: Laravel Forge API token.
    required: true
  github-token:
    description: GitHub token to create an authenticated Octokit client.
    required: false
    default: ${{ github.token }}
  servers:
    description: 'List of Forge servers to use for deploy previews. Each line must contain a domain name and a Forge server ID separated by a space. Note: currently only supports a single server.'
    required: true
  after-deploy:
    description: Shell script to append and run after the default Forge deploy script. E.g. `npm ci && npm run build`.
    required: false
  environment:
    description: Environment variables to add or update on the preview site.
    required: false
  aliases:
    description: Alias domains and subdomains to add to the preview site. Enter multiple aliases on separate lines.
    required: false
  isolated:
    description: Enable Forge site isolation.
    required: false
    default: false
  username:
    description: Set a custom site isolation username.
    required: false
  php-version:
    description: PHP version to use for the preview site, e.g. `8.3`.
    required: false
  existing-certificate:
    description: Existing SSL certificate to use for the preview site.
    required: false
  existing-certificate-key:
    description: Existing SSL certificate private key to use for the preview site.
    required: false
  clone-certificate:
    description: Forge SSL certificate ID to clone to the preview site.
    required: false
  no-certificate:
    description: Skip the creation of a certificate and serve the preview site over HTTP instead of HTTPS.
    required: false
    default: false
  deployment-webhooks:
    description: URLs to send webhooks to after Forge deployments. Enter multiple URLs on separate lines.
    required: false
  deployment-failure-emails:
    description: Email addresses to notify if the Forge deployment fails. Enter multiple emails on separate lines.
    required: false
outputs:
  site-url:
    description: The URL of the deployed preview site.
  site-id:
    description: The Forge ID of the deployed preview site.
runs:
  using: node20
  main: dist/index.js
branding:
  icon: eye
  color: red