Skip to content

This is a plugin for Strapi headless CMS. It lets you trigger a GitHub Action workflow when the site is ready to be published.

License

Notifications You must be signed in to change notification settings

Sam-Apostel/strapi-plugin-webhook-publish

 
 

Repository files navigation

Strapi plugin webhook-publish

NPM version Actions Status PR Welcome

This is a plugin for Strapi headless CMS. It lets you trigger a webhook when the site is ready to be published.

Introduction

Screenshot

When using Strapi as a headless CMS for a statically built website you need a way to trigger the site to rebuild when content has been updated. The typical approach is to setup a Strapi managed webhook to trigger a CI/CD pipeline whenever content changes. This approach has it's issues. For example when making many changes to content, builds are triggered multiple times and deployments can fail due to the site being deployed concurrently.

This plugin tackles the publishing flow a different way. The site administrators can take their time and make many changes and once the content update is complete they can trigger a single build.

Installation

Install this plugin with npm or yarn.

With npm:

npm install strapi-plugin-webhook-publish

With yarn:

yarn add strapi-plugin-webhook-publish

Configuration

Generate a config file at config/plugins.js or config/development/plugins.js etc...

module.exports = ({ env }) => ({
  "webhook-publish": {
    webhook: '[your custom webhook here]'  
  },
});

Use the Plugin

When the plugin has been installed correctly just click on Publishing in the sidebar under plugins then click "Publish".

About

This is a plugin for Strapi headless CMS. It lets you trigger a GitHub Action workflow when the site is ready to be published.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%