https://github.com/south-paw/action-netlify-cli

🙌 Netlify deployments and CLI via GitHub actions
https://github.com/south-paw/action-netlify-cli

action actions continuous-delivery deploy deployment draft github-action github-actions github-deployment github-environments hacktoberfest netlify static-site

Last synced: 2 months ago
JSON representation

🙌 Netlify deployments and CLI via GitHub actions

• Host: GitHub
• URL: https://github.com/south-paw/action-netlify-cli
• Owner: South-Paw
• License: mit
• Created: 2022-10-27T09:46:43.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-13T08:34:04.000Z (over 1 year ago)
• Last Synced: 2024-04-26T08:41:55.809Z (8 months ago)
• Topics: action, actions, continuous-delivery, deploy, deployment, draft, github-action, github-actions, github-deployment, github-environments, hacktoberfest, netlify, static-site
• Language: Shell
• Homepage:
• Size: 14.6 KB
• Stars: 10
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# action-netlify-cli

This action enables arbitrary actions with the [Netlify CLI](https://github.com/netlify/cli)

This action is a replacement for `netlify/actions/cli@master` _without_ the docker layer that incurs an extra 30-50s of runner time (which seems result in an average deploy time of ~1m 30s).

This action usually completes in under a minute (and in best cases, 30s).

## Secrets

- `NETLIFY_AUTH_TOKEN` - _Required_ The token to use for authentication. [Obtain one with the UI](https://www.netlify.com/docs/cli/#obtain-a-token-in-the-netlify-ui)

- `NETLIFY_SITE_ID` - _Optional_ API site ID of the site you wanna work on [Obtain it from the UI](https://www.netlify.com/docs/cli/#link-with-an-environment-variable)

## Outputs

The following outputs will be available from a step that uses this action:

- `NETLIFY_OUTPUT`, the full stdout from the run of the `netlify` command

## Recipes

### Simple publish

```yml

on: [push]

jobs:

  publish:

    runs-on: ubuntu-latest

    steps:

      # build your site for deployment... in this case the `public` folder is being deployed

      - name: Publish

        uses: South-Paw/action-netlify-cli@v2

        id: netlify

        with:

          # be sure to escape any double quotes with a backslash

          args: 'deploy --json --dir \"./public\" --message \"draft [${{ github.sha }}]\"'

        env:

          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}

          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

      # and access outputs in other steps with ${{ steps.netlify.outputs.OUTPUT_ID }}

```

### GitHub deployments

```yml

on: [push]

jobs:

  publish:

    runs-on: ubuntu-latest

    steps:

      - name: Start deployment

        uses: bobheadxi/deployments@v1

        id: deployment

        with:

          env: production

          step: start

      # ... steps to build your site for deployment

      - name: Deploy to Netlify

        uses: South-Paw/action-netlify-cli@v2

        id: netlify

        with:

          # note that the --json flag has been passed so we can parse outputs

          args: deploy --json --prod --dir './public' --message 'production [${{ github.sha }}]'

        env:

          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}

          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

      - name: Finish deployment

        uses: bobheadxi/deployments@v1

        if: always()

        with:

          env: ${{ steps.deployment.outputs.env }}

          step: finish

          status: ${{ job.status }}

          deployment_id: ${{ steps.deployment.outputs.deployment_id }}

          env_url: ${{ fromJson(steps.netlify.outputs.NETLIFY_OUTPUT).url }}

```

### Parse `--json` flag

```yml

on: [push]

jobs:

  publish:

    runs-on: ubuntu-latest

    steps:

      # ... steps to build your site for deployment

      - name: Deploy to Netlify

        uses: South-Paw/action-netlify-cli@v2

        id: netlify

        with:

          # note that the --json flag has been passed so we can parse outputs

          args: deploy --json --prod --dir './public' --message 'production [${{ github.sha }}]'

        env:

          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}

          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

      # You can parse the `NETLIFY_OUTPUT` output with `fromJson` function for the following information:

      - name: Parse NETLIFY_OUTPUT JSON

        run: |

          echo "The URL where the logs from the deploy can be found"

          echo "${{ fromJson(steps.netlify.outputs.NETLIFY_OUTPUT).logs }}"

          echo ""

          echo "the URL of the draft site that Netlify provides"

          echo "${{ fromJson(steps.netlify.outputs.NETLIFY_OUTPUT).deploy_url }}"

          echo ""

          echo "the URL of the "real" site, set only if `--prod` was passed"

          echo "${{ fromJson(steps.netlify.outputs.NETLIFY_OUTPUT).url }}"

```

## Issues and Bugs

If you find any, please report them [here](https://github.com/South-Paw/action-netlify-cli/issues) so they can be squashed.

## License

MIT, see the [LICENSE](https://github.com/South-Paw/awesome-gatsby-starter/blob/master/LICENSE) file.