Netlify Deploy

About

This plugin puts a Publish button on the edit view of the collections you list, and optionally in the admin top bar for single-site setups. Pressing it starts a Netlify build of the site that the document resolves to. The button shows the site state (live, not published, in queue, building, preview ready, build failed, publishing) and a count of documents saved since the last live build. The build log streams into a drawer over a WebSocket, and Netlify's failure reason is shown above the log when a build fails. On sites where auto-publishing is locked in Netlify, a build becomes a preview first. Editors can open the preview on its Netlify URL, publish it, rebuild it after more edits, or cancel and delete it. On unlocked sites the button builds and publishes in one step. The plugin allows only one build at a time per site and locks the button while any build runs, including builds started by a git push, a build hook or the Netlify UI. Builds started in Payload can be cancelled while running. The recent deploys list shows who started each build, its state and its duration. The `site` option takes either a fixed Netlify site id or domain, or a function that receives the current document and returns a per-document site, so one CMS can drive several sites. Access to building and publishing uses ordinary Payload access functions. The `onBuild` and `onPublish` hooks run on the server, for example to notify a Slack channel. The Netlify personal access token must be set as a server-side environment variable, and the plugin requires Node 22 or later for the WebSocket log stream. It only works with sites that build on Netlify, not with sites uploaded from an external CI.

Package info

Package name

@focus-reactive/payload-plugin-netlify-deploy

Latest version

1.1.0

Unpacked size

185 kB

License

MIT

Weekly downloads

114

Last publish

Sep 29, 2026