hubot-statuspageio

    1.0.9 • Public • Published

    Hubot-statuspageio

    This plugin is based on the usage we have in Gandi of StatusPage.io. It may, in its first instance, not match your setup, so please verify that first.

    Configuration

    # STATUSPAGE_API_KEY v2 configuration vars
    export STATUSPAGE_API_KEY="" # statuspage issued api key
    export STATUSPAGE_PAGE_ID="" # page id as visible in page url
    export STATUSPAGE_ANNOUNCE_ROOM="" # where to announce change on status
    export STATUSPAGE_ENDPOINT="" # webhook endpoint to receive notification 
    export STATUSPAGE_CUSTOM_EMIT = "" # action to trigger when a notification is received
    

    Usage

    sp <incident_id> + comment - add a comment to an incident
    sp <incident_id> is <none,minor,major,critical> - set the impact of an inciden
    sp [inc] - give the ongoing incidents
    sp c[omp] [comp_name] - get a component or list them all
    sp c[omp] <comp_name,comp_name> is op|maj|min|main - set a component to a given state
    sp t[emplates] [name] - get a list of templates, filter with names
    sp inc <incident_id> - give the details about an incident
    sp main[tenance] - give the ongoing maintenance
    sp new <template_name> on <component:status,component:status...> - create new status using template_name on component(s)
    sp set <incident_id> <id|mon|res> [comment] update a status
    sp version - give the version of hubot-statuspage loaded
    version - displays the version of this bot
    what role does <user> have - Find out what roles are assigned to a specific user
    

    Development

    Changelog

    All changes are listed in the CHANGELOG

    Testing

    npm install
    
    # will run make test and coffeelint
    npm test 
    
    # or
    make test
    
    # or, for watch-mode
    make test-w
    
    # or for more documentation-style output
    make test-spec
    
    # and to generate coverage
    make test-cov
    
    # and to run the lint
    make lint
    
    # run the lint and the coverage
    make
    

    Contribute

    Feel free to open a PR if you find any bug, typo, want to improve documentation, or think about a new feature.

    Gandi loves Free and Open Source Software. This project is used internally at Gandi but external contributions are very welcome.

    Attribution

    Authors

    License

    This source code is available under MIT license.

    Copyright

    Copyright (c) 2019 - Gandi - https://gandi.net

    Install

    npm i hubot-statuspageio

    DownloadsWeekly Downloads

    27

    Version

    1.0.9

    License

    MIT

    Unpacked Size

    25.2 kB

    Total Files

    8

    Last publish

    Collaborators

    • kolo