Strapi plugin logo for Netlify Deployments

Netlify Deployments

Strapi v4 plugin to trigger, monitor and cancel a deployment on Netlify.

thumbnail for Netlify Deployments

Netlify Deployments

npm version strapi market link

Strapi v4 plugin to trigger, monitor, and cancel deployments on one or more Netlify sites.

Plugin Preview

Home Page:

Plugin Home Page

Settings Page:

Plugin Settings Page

Installation

Install dependency

Run the following command in your Strapi project to install netlify-deployments:

1
2
3
yarn add strapi-plugin-netlify-deployments
# or
npm i -S strapi-plugin-netlify-deployments

Enable plugin configuration

Open config/plugins.js file and add the netlify-deployments entry:

1
2
3
4
5
module.exports = ({ env }) => ({
  "netlify-deployments": {
    enabled: true,
  },
});

Run

You can now run Strapi:

1
yarn develop

You should see the Netlify Deployments menu in the left panel.

Note: You may need to run yarn build in order to see the new menu entries.

Then you can proceed with the plugin configuration.

Plugin Configuration

Config properties

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
module.exports = ({ env }) => ({
  "netlify-deployments": {
    enabled: true,
    config: {
      accessToken: "<netlify-access-token>",
      sites: [
        {
          name: 'Site 1',
          id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          buildHook: "https://api.netlify.com/build_hooks/<hook_id>",
          branch: 'master' // optional
        }
      ]
    },
  },
});

The plugin is reading the following configuration variables to work:

  • accessToken: Access token of your Netlify account used to fetch the list of deployments

  • sites: An array of Netlify sites to view and manage deploys.

    • The array must have objects with a name, id, and buildHook. Optionally, you can include a branch to override the default value of master. The id can be found under Site settings > General and you can follow this guide to create a build hook.

Environment Configuration

You shouldn't disclose your Access Token for security reasons. Therefore, you shouldn't add this value to versioning in a public git repository. A suggested solution is to use an environment variable. Example:

1
2
3
4
5
6
7
8
module.exports = ({ env }) => ({
  "netlify-deployments": {
    enabled: true,
    config: {
      accessToken: process.env.NETLIFY_DEPLOYMENTS_PLUGIN_ACCESS_TOKEN
    },
  },
});

Local development

For local development, you can add the config properties in your .env file:

1
NETLIFY_DEPLOYMENTS_PLUGIN_ACCESS_TOKEN="<netlify-access-token>"

Server

You can save these values as process env variable on your server (e.g. this guide is for Heroku).

Credits

Thanks to gianlucaparadise for making strapi-plugin-vercel-deploy which this was based on.

Install now

npm install strapi-plugin-netlify-deployments

Last updated

116 days ago

Strapi Compatibility

Unavailable

Author

github profile image for Jarrett Lusso
Jarrett Lusso

Useful links

Create your own plugin

Check out the available plugin resources that will help you to develop your plugin or provider and get it listed on the marketplace.