.gitignore

@@ -11,6 +11,9 @@ node_modules
 lib/index.d.ts
 lib/index.js.flow
 
+# API DOCs are generated before publish
+doc/
+
 logs
 *.log
 npm-debug.log*

.travis.yml

@@ -1,5 +1,6 @@
 language: node_js
 node_js:
+  - "9"
   - "8"
   - "6"
   - "4"

CONTRIBUTING.md

@@ -44,4 +44,7 @@ Only one version number is bumped at a time, the highest version change trumps t
 Besides publishing a new version to npm, semantic-release also creates a git tag and release
 on GitHub, generates changelogs from the commit messages and puts them into the release notes.
 
+Before the publish it runs the `npm run build` script which generates type definitions for Flow & Typescript based on the [templates](scripts/templates/).
+The script also generates the API docs. After the publish, the API docs are automatically pushed to the `gh-pages` branch which updates the documentation at  [octokit.github.io/node-github](http://octokit.github.io/node-github/).
+
 If the pull request looks good but does not follow the commit conventions, use the "Squash & merge" button.

README.md

@@ -32,13 +32,13 @@ GitHub API: [developer.github.com/v3](https://developer.github.com/v3/)
 
 Get all followers for user "defunkt":
 
+<!-- HEADS UP: when changing the options for the constructor, make sure to also
+     update the type definition templates in scripts/templates/* -->
 ```js
 var GitHubApi = require('github')
 
 var github = new GitHubApi({
     // optional
-  debug: true,
-  Promise: require('bluebird'),
   timeout: 5000,
   host: 'github.my-GHE-enabled-company.com', // should be api.github.com for GitHub
   pathPrefix: '/api/v3', // for some GHEs; none for GitHub
@@ -52,7 +52,6 @@ var github = new GitHubApi({
     'user-agent': 'something custom'
   },
   requestMedia: 'application/vnd.github.something-custom',
-  followRedirects: false, // default: true; there's currently an issue with non-get redirects, so allow disabling follow-redirects
   rejectUnauthorized: false, // default: true
   family: 6
 })
@@ -129,11 +128,6 @@ github.authenticate({
   type: 'integration',
   token: 'jwt'
 })
-
-// ~/.netrc
-github.authenticate({
-  type: 'netrc'
-})
 ```
 
 Note: `authenticate` is synchronous because it only stores the
@@ -161,9 +155,9 @@ github.authorization.create({
 })
 ```
 
-## Promises
+## DEBUG
 
-See example [here](https://github.com/octokit/node-github/blob/master/examples/testPromiseGetNextPage.js).
+Set `DEBUG=node-github:*` for additioanl debug logs.
 
 ## Tests
 
@@ -212,17 +206,6 @@ For updates on endpoints under preview, see https://developer.github.com/changes
 | Timeline                | application/vnd.github.mockingbird-preview            |
 | Topics                  | application/vnd.github.mercy-preview+json             |
 
-## Dev notes
-
-To update the apidoc for github pages:
-
-```bash
-$ npm install apidoc -g
-$ apidoc -i doc/ -o apidoc/
-```
-
-Just a reminder, since an ad-hoc filter was added to the apidoc, don't overwrite index.html, main.js.
-
 ## LICENSE
 
-MIT license. See the LICENSE file for details.
+[MIT](LICENSE)

examples/testPromise.js

@@ -0,0 +1,17 @@
+'use strict'
+
+var Client = require('./../lib/index')
+
+var github = new Client({
+  debug: false
+})
+
+github.orgs.getAll({
+  page: 5,
+  per_page: 100
+}).then(function (res) {
+  console.log(res)
+  return github.users.getById({ id: '429706' })
+}).then(function (res) {
+  console.log(res)
+})

lib/definitions.json

@@ -457,6 +457,27 @@
             "validation": "",
             "invalidmsg": "",
             "description": "Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise."
+        },
+        "url": {
+            "type": "String",
+            "required": true,
+            "validation": "",
+            "invalidmsg": "",
+            "description": "Dynamic URL for release asset uploads returned by the release’s API response."
+        },
+        "contentType": {
+            "type": "String",
+            "required": true,
+            "validation": "",
+            "invalidmsg": "",
+            "description": "The content type of a release asset upload."
+        },
+        "contentLength": {
+            "type": "Number",
+            "required": true,
+            "validation": "",
+            "invalidmsg": "",
+            "description": "Size of release asset upload in bytes."
         }
     },
     "acceptTree": {

lib/error.js

@@ -13,7 +13,6 @@ var Util = require('util')
 
 exports.HttpError = function (message, code, headers) {
   Error.call(this, message)
-    // Error.captureStackTrace(this, arguments.callee);
   this.message = message
   this.code = code
   this.status = statusCodes[code]
@@ -97,7 +96,7 @@ for (var status in statusCodes) {
   var error = (function (defaultMsg, status) {
     return function (msg) {
       this.defaultMessage = defaultMsg
-      exports.HttpError.call(this, msg || status + ': ' + defaultMsg, status)
+      exports.HttpError.call(this, msg, status)
 
       if (status >= 500) { Error.captureStackTrace(this, arguments.callee) } // eslint-disable-line
     }