action-netlify-deploy

KO | EN

gitlite — search

#python #react #ai #go #android #linux #macos #awesome #cli #kubernetes #awesome-list #security #mcp #open-source

action-netlify-deploy

(★ 33)

🙌 Netlify deployments via GitHub actions

action-netlify-deploy 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# action-netlify-deploy

🙌 Netlify deployments via GitHub actions

![CI](https://github.com/South-Paw/action-netlify-deploy/workflows/CI/badge.svg)
[![Dependencies](https://david-dm.org/South-Paw/action-netlify-deploy/status.svg)](https://david-dm.org/South-Paw/action-netlify-deploy)
[![Dev Dependencies](https://david-dm.org/South-Paw/action-netlify-deploy/dev-status.svg)](https://david-dm.org/South-Paw/action-netlify-deploy?type=dev)

## About

A Github action that deploys a build directory to Netlify. It can be configured to comment on the commit or PR with the deploy URL or deploy with GitHub environments, deploy draft builds, deploy Netlify functions and use custom Netlify configs.

## Getting started

There are 4 required inputs for the action

- `github-token` which is usually `${{ secrets.GITHUB_TOKEN }}`
- `netlify-auth-token` this is a [personal access token](https://app.netlify.com/user/applications#personal-access-tokens) created from your Netlify account
  - ⚠️ This should be stored as a [Github secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) in your repo
- `netlify-site-id` this is the API ID of your Netlify site
  - To find this, go to your site's settings and in the "site information" copy the `API ID` field
- `build-dir` this is where your site build outputs to relative to the root of your projects folder

See the [action.yml](./action.yml) for other action inputs and their descriptions

## Outputs

### `preview-url`

The url of deployment preview.

### `preview-name`

The name of deployment name.

## Usage

Here are some ideas of how to configure this action in different workflows...

- [Deploying drafts on each commit and publishing on push to master](https://github.com/South-Paw/action-netlify-deploy#deploying-drafts-on-each-commit-and-publishing-on-push-to-master)
- [Deploying drafts of pull requests and publishing on push to master](https://github.com/South-Paw/action-netlify-deploy#deploying-drafts-of-pull-requests-and-publishing-on-push-to-master)
- [Deploying drafts of pull requests and publish on release created](https://github.com/South-Paw/action-netlify-deploy#deploying-drafts-of-pull-requests-and-publish-on-release-created)

### Deploying drafts on each commit and publishing on push to master

```yaml
name: CI

on: [push]

jobs:
  # This job will:
  #   * deploy a draft every time there is a commit that is not on master branch
  #   * comment on that commit with the deploy URL
  deployCommitDraft:
    name: Deploy draft to Netlify
    runs-on: ubuntu-latest
    if: github.event_name == 'push' && github.ref != 'refs/heads/master'
    steps:
      - name: Checkout repository
        uses: actions/checkout@v1