actions-marketplace-validations/Netlify Deploy Action with Outputs
Netlify deployments via GitHub actions
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | GitHub token | yes | — |
| netlify-auth-token | Your Netlify personal access token (Please save it as a secret in your repo!) | yes | — |
| netlify-site-id | Your Netlify site's `API ID` | yes | — |
| build-dir | The folder of the site want to deploy | yes | — |
| comment-on-commit | If `true` AND the context of the action is a `commit` then the action will comment on the SHA. | no | false |
| comment-on-pull-request | If `true` AND the context of the action is a `pull_request` then the action will comment on the PR. | no | false |
| github-deployment-environment | The name of the GitHub environment to deploy to. | no | — |
| github-deployment-description | Optional description to add to the deployment. | no | — |
| github-deployment-is-transient | Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. | no | false |
| github-deployment-is-production | Specifies if the given environment is one that end-users directly interact with. | no | true |
| github-deployment-should-report-status | If `true` AND `github-env` is set then the action will report the status of environment deployments on pull requests. | no | true |
| dry-run | Run the action but don't actually deploy to Netlify or comment on the commit/PR | no | false |
| functions-dir | The folder of any functions to deploy | no | — |
| config-path | Path to a netlify.toml file to include in the deploy | no | — |
| draft | If it is a draft deploy or production deploy | no | false |
| message | A short message to associate with the deploy (Note: setting this will override the default deploy message of `<type>: <title> [short_sha]`) | no | — |
Outputs
| name | description |
|---|---|
| preview-url | deployment preview URL |
| preview-name | deployment preview name |