JSPM

github-wiki-notifier

0.1.3
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
    • 0
  • Score
    100M100P100Q17960F
  • License MIT

Notify diff of GitHub Wiki from GitHub Webhook payload

Package Exports

  • github-wiki-notifier

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-wiki-notifier) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

github-wiki-notifier

NPM version NPM downloads Build Status Coverage Status Dependency Status DevDependency Status License

Notify diff of GitHub Wiki from GitHub Webhook payload.

Installation

npm install -g github-wiki-notifier

Usage

Usage: github-wiki-notifier <notifier>
                            [--paylod=<path>]
                            [--repository=<path>]
                            [--clone-dir=<path>]
                            [--max-message-length=<number>]
                            [--dry-run]
                            [--output-message]

Notify diff of GitHub wiki to Chat

Options:
  -p, --payload         Set path to GitHub Webhook payload for gollum  [string]
  -r, --repository      Set path to repository  [string]
  -c, --clone-dir       Set path to cloning remote repository [default: ./<repo>]  [string]
  --max-message-length  Set max length of message for contains diff
  --dry-run             Set flag to disable notify  [boolean]
  --output-message      Set flag to output notify message  [boolean]
  --help                Show help  [boolean]
  --version             Show version number  [boolean]

Examples:
  github-wiki-notifier hipchat --payload=/path/to/json     Notify to HipChat from payload file in local
  github-wiki-notifier hipchat --repository=/path/to/repo  Notify latest diff to HipChat from repo in local
  github-wiki-notifier hipchat                             Notify to HipChat from payload string of environment variable

More detail, See Doc.

Configuration

General

  • (optional): GHWIKINOTIFIER_GITHUB_TOKEN: Auth Token (repo scope required) if you have to use https protocol to clone private repository
  • (optional) GHWIKINOTIFIER_WEBHOOK_PAYLOAD: Stringified json of GitHub Webhook payload (ex. GHWIKINOTIFIER_WEBHOOK_PAYLOAD=jq . /path/to/json)

HipChat

  • (require) GHWIKINOTIFIER_HIPCHAT_ROOM: Hipchat Room ID
  • (require) GHWIKINOTIFIER_HIPCHAT_ROOM_TOKEN: HipChat notify token

Todo

  • Add tests
  • Add pluggable notifier