nuxt-deploy-notifier

    0.0.3 • Public • Published

    Nuxt Build Notifier

    Latest Version on NPM Software License npm npm

    This module provides a simple Slack notification of your deployment after success.

    Installation

    yarn add nuxt-deploy-notifier

    Usage

    Simply add the module to your nuxt config:

    export default {
        buildModules: [
            'nuxt-deploy-notifier',
        ],
    }

    And define any applicable options:

    export default {
        deployNotifiers: {
            appName: null, // required
            slackChannel: null, // required
            slackWebhookUrl: null, // required
        },
    }

    Options

    The following options are available:

    APP_URL

    • Type: string
    • Required: true
    • Description: Set this from .env file

    appName

    • Type: string
    • Required: true
    • Description: The application name

    slackWebhookUrl

    • Type: string
    • Required: true

    slackChannel

    • Type: string
    • Required: true

    The webhook url to send the Slack notification to your channel of choice. For information on how to setup a webhook, check out the Slack Documentation. If no value is supplied, no notification will be sent.

    Contact

    Email: chantouchsek.cs83@gmail.com

    Twitter @DevidCs83

    License

    This package is under the MIT License.

    Install

    npm i nuxt-deploy-notifier

    DownloadsWeekly Downloads

    7

    Version

    0.0.3

    License

    MIT

    Unpacked Size

    8.58 kB

    Total Files

    9

    Last publish

    Collaborators

    • chantouchsek