@neoblog/plugin-github-webhook
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

GitHub Webhook Plugin for Neoblog

Reload server when receive GitHub webhook.

What does this plugin actually does

  1. sync the repo and install dependencies
git fetch --all
git git reset --hard origin/master
npm ci
  1. reload the server
neoblog.reload();

Configuration

in NeoBlog config.js:

const GitHubWebhookPlugin = require('@neoblog/plugin-github-webhook');

module.exports = {
    // ...
    plugins: [
        // ...
        new GitHubWebhookPlugin({
            secret: 'a-very-long-secret-that-should-be-generated',
            path: '/path/to/webhook',
            localRef: 'origin/master'
        })
        // ...
    ]
    // ...
};

then setup webhook in GitHub porject settings.

Package Sidebar

Install

npm i @neoblog/plugin-github-webhook

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

5.97 kB

Total Files

4

Last publish

Collaborators

  • neoblog-the-owner
  • rocka