netlify-publish-action

A repo used for developing a scheduled Action to trigger Netlify deploys.

This action only applies to the following use case:

You have builds active in your Netlify Site.
Publishing on the production branch is locked.
You want to be able to publish the latest production deploy on a schedule.

This is useful if you don't want Netlify to publish your production branch automatically, but rather prefer to have updates pushed to the production website at specific intervals.

The Action does the following:

Sends a GET request to /sites/{siteID}/deploys to find the ID of the currently-locked deploy.
Sends a POST to /sites/{siteID}/deploys/{deployID}/unlock to unlock the deploy, where {deployID} is the id returned in the previous step.
Sends a GET request to sites/{siteID}/deploys to find the most recent production deploy and capture the id returned in the response.
Sends a POST request to /sites/{siteID}/deploys/{deployID}/restoreSiteDeploy where {deployID} is the id returned in the previous step.
Sends a POST request to /sites/{siteID}/deploys/{deployID}/lock where {deployID} is the same id returned in step 3.

Inputs

The Action requires the following inputs:

netlify-auth-token: Your Netlify PAT.
netlify-site-id: The API Site ID for your Netlify Site.

Outputs

The Action returns the following outputs:

lockedDeployID: The ID of the locked production deploy.
latestDeployID: The ID of the most recent deploy on the production branch.

Example:

jobs:
  netlify_deploy_job:
    runs-on: ubuntu-latest
    name: Unlock latest production deploy
    steps:
      - name: Unlock and publish netlify deploys
        id: deploy
        uses: jputrino/netlify-publish-action@v0.2.0
        with:
          netlify-auth-token: ${{ secrets.NETLIFY_AUTH_TOKEN }}
          netlify-site-id: ${{ secrets.NETLIFY_SITE_ID }}
      - name: Get the outputs
        run: |
          echo "Successfully unlocked deploy ${{ steps.deploy.outputs.lockedDeployID}}"   
          echo "Successfully published and locked deploy ${{ steps.deploy.outputs.latestDeployID}}"

Packaging

This project uses @vercel/ncc for compilation.

Installation

npm i

Compilation

Remove the dist and lib folders.
```
npm run all
```