Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nwtgck/actions-netlify
🚀 Netlify deploy from GitHub Actions
https://github.com/nwtgck/actions-netlify
actions deployment github-actions netlify static-site
Last synced: about 2 months ago
JSON representation
🚀 Netlify deploy from GitHub Actions
- Host: GitHub
- URL: https://github.com/nwtgck/actions-netlify
- Owner: nwtgck
- License: mit
- Created: 2020-02-04T13:11:16.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-31T19:47:47.000Z (about 2 months ago)
- Last Synced: 2024-08-01T04:02:02.096Z (about 2 months ago)
- Topics: actions, deployment, github-actions, netlify, static-site
- Language: TypeScript
- Homepage:
- Size: 41.7 MB
- Stars: 323
- Watchers: 3
- Forks: 41
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-actions - Netlify Deploy GitHub Action for each commit
- fucking-awesome-actions - Netlify Deploy GitHub Action for each commit
- awesome-workflows - Netlify Deploy GitHub Action for each commit
- project-awesome - nwtgck/actions-netlify - 🚀 Netlify deploy from GitHub Actions (TypeScript)
README
# actions-netlify
GitHub Actions for deploying to Netlify
Deploy URLs are commented on your pull requests and commit comments!
GitHub Deployments are also supported!
## Usage
```yaml
# .github/workflows/netlify.yml
name: Build and Deploy to Netlify
on:
push:
pull_request:
jobs:
build:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
# ( Build to ./dist or other directory... )
- name: Deploy to Netlify
uses: nwtgck/[email protected]
with:
publish-dir: './dist'
production-branch: master
github-token: ${{ secrets.GITHUB_TOKEN }}
deploy-message: "Deploy from GitHub Actions"
enable-pull-request-comment: false
enable-commit-comment: true
overwrites-pull-request-comment: true
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
timeout-minutes: 1
```
### Required inputs and env
- `publish-dir` (e.g. "dist", "_site")
- `NETLIFY_AUTH_TOKEN`: [Personal access tokens](https://app.netlify.com/user/applications#personal-access-tokens) > New access token
- `NETLIFY_SITE_ID`: team page > your site > Settings > Site details > Site information > API ID
- NOTE: API ID is `NETLIFY_SITE_ID`.
### Optional inputs
- `production-branch` (e.g. "master")
- `production-deploy`: Deploy as Netlify production deploy (default: false)
- `github-token: ${{ secrets.GITHUB_TOKEN }}`
- `deploy-message` A custom deploy message to see on Netlify deployment (e.g. `${{ github.event.pull_request.title }}`)
- `enable-pull-request-comment: true` Comment on pull request (default: true)
- `enable-commit-comment: true` Comment on GitHub commit (default: true)
- `enable-commit-status: true` GitHub commit status (default: true)
- `overwrites-pull-request-comment: true` Overwrites comment on pull request (default: true)
- `netlify-config-path: ./netlify.toml` Path to `netlify.toml` (default: undefined)
- `functions-dir` Netlify functions output directory (default: undefined)
- `alias` Specifies the prefix for the deployment URL, must not have uppercase or special characters (default: Netlify build ID)
- `alias: ${{ github.head_ref }}` replicates the [branch deploy prefix](https://docs.netlify.com/site-deploys/overview/#definitions)
- `alias: deploy-preview-${{ github.event.number }}` replicates the [deploy preview prefix](https://docs.netlify.com/site-deploys/overview/#definitions)
- `enable-github-deployment` Whether or not to deploy to GitHub (default: true)
- `github-deployment-environment` Environment name of GitHub Deployments
- `github-deployment-description` Description of the GitHub Deployment
- `fails-without-credentials` Fails if no credentials provided (default: false)
### Paths are relative to the project's root
All paths (eg, `publish-dir`, `netlify-config-path`, `functions-dir`) are relative to the project's root or absolute paths.
### Outputs
- `deploy-url` A deployment URL generated by Netlify
## Build on local
```bash
npm ci
npm run all
```