v16

[gr2m]

Tracking v16 release

Work in Progress

• typescript definitions for static methods (not generated). Need to be added to /scripts/templates/index.d.ts.tpl
  • octokit.request, octokit.request.endpoint, octokit.request.endpoint.merge, octokit.request.endpoint.parse
  • octokit.hook, octokit.hook.before, octokit.hook.after, octokit.hook.error, octokit.hook.wrap
  • octokit.plugin
  • octokit.registerEndpoints

After release

• update @octokit/rest version in https://github.com/gr2m/octokit-pagination-methods/blob/master/package.json
• In release notes
  • Mention breaking change: error.status is now the response status code. The status text is no longer returned.
  • Mention to install with ^15.18.0 (npm install @octokit/rest@15.18.0) first, then run tests with | grep DEPRECATED and rename all the methods / parameters, then install v16 and it should just work ™️
  • reduction of node_modules folder size (5mb+ to <1mb)
  • reduction of bundle size (~28kb to ~18kb)

Done

• Rename routes to align better with docs on https://developer.github.com/v3/ #1094 Rename method names to align better with docs on https://developer.github.com/v3/. Deprecate old method names
• line-by-line code review to remove all obsolete code
• go through open issues & PRs
• Generate routes for real #1097 generate routes for real
• remove tests for deprecations
• error.status request.js#11 v16: error.code -> error.status, deprecate error.code.
• deprecate callbacks #1091 deprecate callback APIs (remove from API docs)
• deprecate options.input #1092 deprecate input parameter in favour of data
• deprecate error.toJSON #1093 deprecate error.toJSON()
• Async Iterators for paginated results #910 .paginate()
• Async Iterators for paginated results #910 deprecate v15 pagination methods
• create octokit-pagination-methods package
• move SCIM routes into plugin / separate repository. This will be a good showcase on how to use a build step to turn the routes format https://github.com/octokit/routes into the format that octokit.registerEndpoints() wants, while using the format from ocotkit/routes to generate documentation (Repo: https://github.com/octokit/plugin-scim.js)
• Add method to register custom endpoint methods #829 Add method to register custom endpoint methods (Pull Request: octokit.registerEndpoints(routes) #1086)
• add all non-breaking changes from https://github.com/octokit/rest.js/pull/1043 to v15 (PR: https://github.com/octokit/rest.js/pull/1081)
• make plugin API public (see discussion at 📯 Feedback wanted: plugin API #1074)
• octokit.request & octokit.request.endpoint #1065 Use @octokit/request / @octokit/endpoint libraries in @octokit/rest. Make client.request and client.request.endpoint public APIs
• implement new hooks API – see discussion at 📯 Feedback wanted: Hooks API #1069
• publish @octokit/endpoint (https://github.com/octokit/endpoint.js)
• publish @octokit/request (https://github.com/octokit/request.js)
• Parse JSON from GitHub error messages #684 parse JSON from GitHub Errors
• Rename routes to align better with docs on https://developer.github.com/v3/ #889 Rename routes to align better with docs on https://developer.github.com/v3/, PR: [WIP] generate routes for real #1043

FAQ

• Will it be possible to use a custom request library?

  Yes it will be possible, using the a new hooks API:

  const axios = require('axios');
  github.hook.wrap('request', (request, options) => {
    return axios(options)
  })

---

closes #1068, closes #1069, closes #1074, closes #988, closes #829, closes #778, closes #777, closes #688, closes #687, closes #601, closes #766, closes #824

[octokitbot]

🎉 This PR is included in version 16.0.0 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀