Package Exports

docloop-github-adapter

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 (docloop-github-adapter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

GithubAdapter

This package is meant to be used with docloop.

Install like this:

npm install docloop-github-adapter

Before you can actually use the GithubAdapter, you will have to register a GithubApp. Each installation of the GithubApp needs acces to issues.

Use the credentials from your app's configuration page to configure your GithubAdapter like this (see docloop):

var PaperhiveAdapter = require('docloop-paperhive-adapter').PaperhiveAdapter 

docloopCore
.use(GithubAdapter, {
    name:             'GitHub',
    app:              {
                        id:                 0000,
                        secret:             "some_secret",
                        privateKeyLocation: "my_secret.private-key.pem",
                        installationLink:   "link_to_my_github_app",
                      },
    extraEndpoints:   false,
    eventQueue:       {
                        delay:            [0, 1000, 5000],
                        minDelay:         0,
                        maxAttempts:      3,
                        processInterval:  10*60*1000,
                        spread:           1000,
                      },
    oAuth:            {
                        clientId:       "github_app_client_id",
                        clientSecret:   "github_app_client_secret",
                        accessTokenUrl: "https://github.com/login/oauth/access_token",                  
                        authUrl:        "https://github.com/login/oauth/authorize?scope=user:email&client_id={{github_app_client_id}}",
                      },
    dummy:            {
                        title:  "docLoop: dummy",
                        body: "_docLoop: dummy for missing parent_"
                      }
})

Here's the documentation: docloopDocs