action.yml

name: Netlify Deploy Action
description: Netlify deployments via GitHub actions
author: Alex Gabites <https://github.com/South-Paw>
branding:
  color: purple
  icon: package
runs:
  using: "node12"
  main: "dist/index.js"
inputs:
  # Required inputs
  github-token:
    description: GitHub token
    required: true
  netlify-auth-token:
    description: Your Netlify personal access token (Please save it as a secret in your repo!)
    required: true
  netlify-site-id:
    description: Your Netlify site's `API ID`
    required: true
  build-dir:
    description: The folder of the site want to deploy
    required: true
  # Config inputs
  comment-on-commit:
    description: If `true` AND the context of the action is a `commit` then the action will comment on the SHA.
    required: false
    default: "false"
  comment-on-pull-request:
    description: If `true` AND the context of the action is a `pull_request` then the action will comment on the PR.
    required: false
    default: "false"
  github-deployment-environment:
    description: The name of the GitHub environment to deploy to.
    required: false
  github-deployment-description:
    description: Optional description to add to the deployment.
    required: false
  github-deployment-is-transient:
    description: Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future.
    required: false
    default: "false"
  github-deployment-is-production:
    description: Specifies if the given environment is one that end-users directly interact with.
    required: false
    default: "true"
  github-deployment-should-report-status:
    description: If `true` AND `github-env` is set then the action will report the status of environment deployments on pull requests.
    required: false
    default: "true"
  dry-run:
    description: Run the action but don't actually deploy to Netlify or comment on the commit/PR
    required: false
    default: "false"
  # Other optional inputs (see: https://github.com/netlify/js-client#deploy--await-clientdeploysiteid-builddir-opts)
  functions-dir:
    description: The folder of any functions to deploy
    required: false
  config-path:
    description: Path to a netlify.toml file to include in the deploy
    required: false
  draft:
    description: If it is a draft deploy or production deploy
    required: false
    default: "false"
  message:
    description: "A short message to associate with the deploy (Note: setting this will override the default deploy message of `<type>: <title> [short_sha]`)"
    required: false
outputs:
  preview-url:
    description: "deployment preview URL"
  preview-name:
    description: "deployment preview name"