Negligent Pachinko Machine

    github-to-discourse

    2.1.0 • Public • Published

    GitHub to Discourse

    npm

    This is very simple.

    It will forward any 'push' webhooks it receives to a specified thread on a Discourse forum. I couldn't find anything similar around, presumably because people don't really use Discourse to publish new commits. But hey, maybe there's a use-case somewhere.

    Install

    1. npm install -g github-to-discourse
    2. cd `npm root -g`/github-to-discourse
    3. mv config.json.0 config.json and edit properties (see below)
    4. g2d

    Note: You can also run g2d /path/to/config.json with a custom path, otherwise config.json will be used.

    Config.json Format

    Note: All properties are required unless listed otherwise

    discourse

    api_key

    Your Discourse API Key. You should ask an admin for this. They'll need your username as well.

    api_user

    Your Discourse username.

    domain

    The domain of your Discourse server, without protocols or slashes. e.g. meta.discourse.org.

    https_enabled

    Does the Discourse server use HTTPS? This is optional, defaults to false

    topic_id

    The topic that the program should be posting replies to. You can get this from the number at the end of your topic URL: For https://meta.discourse.org/t/presence-features-for-forums/12 it's 12.

    onebox_enabled

    Some Discourse installations enable a 'onebox' for GitHub commit links, which displays them in a fancy format with the title and message. If you'd like to use this, and your server supports it, you can set this to true. Otherwise it's optional, and defaults to false.

    repository

    default_branch_only

    Only processes commits to the default branch (configurable on GitHub). false by default.

    webhook

    path

    The path name on your server that GitHub is sending Webhooks to. Include no slashes, e.g. push-to-here if you're hooking to http://myurl.com/push-to-here.

    port

    The port to run on. Optional, will default to 8080.

    secret

    Your secret for the GitHub webhook.

    Keywords

    none

    Install

    npm i github-to-discourse

    DownloadsWeekly Downloads

    10

    Version

    2.1.0

    License

    MIT

    Unpacked Size

    9.11 kB

    Total Files

    5

    Last publish

    Collaborators

    • huw