Newline Pending Merge

    @quarva/netlify-plugin-sitrep

    0.0.8 • Public • Published

    netlify-plugin-sitrep

    Netlify Status npm (scoped) FOSSA Status

    A Netlify build plugin that injects build and deploy information into the DOM for debugging.

    Live demo

    Demo

    Usage

    Set up your Netlify environment variables

    The plugin accesses Netlify's postprocessing snippet injection using the Netlify API, so we need to provide an access token.

    1. Sign in to Netlify and navigate to User Settings → Applications
    2. Generate a new personal access token
    3. Store that personal access token as a build environment variable called BUILD_SITREP_TOKEN in the site(s) you want to use the plugin with.

    Required environment variables for development

    Variable Name Description
    BUILD_SITREP_TOKEN Must be configured by the user
    SITE_ID Must be configured by the user
    DEPLOY_ID provided by Netlify, but can be configured by the user
    BUILD_ID provided by Netlify, but can be configured by the user

    Install

    npm install --save @quarva/netlify-plugin-sitrep
    
    or 
    
    yarn add @quarva/netlify-plugin-sitrep

    Add the plugin to netlify.toml

    [[plugins]]
    package = "@quarva/netlify-plugin-sitrep"

    Note: The [[plugins]] line is required for each plugin, even if you have other plugins in your netlify.toml file already.

    Configuration

    By default, the plugin won't inject any data in a production context. You can adjust that with the allow_prod input.

    [[plugins]]
    package = "@quarva/netlify-plugin-sitrep"
      [plugins.inputs]  
        "allow_prod" = ""
        # If true, the plugin will inject data even when run in a production context.
        "verbose" = ""
        # If true, the plugin will write each step to the deploy log.

    Install

    npm i @quarva/netlify-plugin-sitrep

    DownloadsWeekly Downloads

    3

    Version

    0.0.8

    License

    MIT

    Unpacked Size

    14.4 kB

    Total Files

    7

    Last publish

    Collaborators

    • culturestate