simonplend
commented
4 years ago Merging this pull request will fix the deprecation warning that is outputted when running this CLI tool:
[@octokit/rest] `const Octokit = require("@octokit/rest")` is deprecated. Use `const { Octokit } = require("@octokit/rest")` instead
This PR contains the following updates:
^16.0.0->^17.0.0:information_source: Find our documentation at https://github.com/Financial-Times/next/wiki/Renovate.
Release Notes
octokit/rest.js
### [`v17.6.0`](https://togithub.com/octokit/rest.js/releases/v17.6.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.5.2...v17.6.0) ##### Features - **typescript:** set types for parameters and results/responses automagically ([#1690](https://togithub.com/octokit/rest.js/issues/1690)) ([80e87a0](https://togithub.com/octokit/rest.js/commit/80e87a04d1d5f99fffcbc48c303e3a1e262e263f)) ### [`v17.5.2`](https://togithub.com/octokit/rest.js/releases/v17.5.2) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.5.1...v17.5.2) ##### Bug Fixes - **typescript:** remove obsolete `?{page,per_page}` parameters ([#1685](https://togithub.com/octokit/rest.js/issues/1685)) ([a4c536d](https://togithub.com/octokit/rest.js/commit/a4c536da9b40963b3eafc15672190210a42a5ad5)) ### [`v17.5.1`](https://togithub.com/octokit/rest.js/releases/v17.5.1) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.5.0...v17.5.1) ##### Bug Fixes - **typescript:** define `.defaults()` method on rest endpoint method types ([#1681](https://togithub.com/octokit/rest.js/issues/1681)) ([4f23359](https://togithub.com/octokit/rest.js/commit/4f23359f11d828255254808b6049159665285062)) ### [`v17.5.0`](https://togithub.com/octokit/rest.js/releases/v17.5.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.4.0...v17.5.0) ##### Features - **typescript:** `import { RestEndpointMethodTypes } from "@octokit/rest";` ([#1680](https://togithub.com/octokit/rest.js/issues/1680)) ([6a9f9a4](https://togithub.com/octokit/rest.js/commit/6a9f9a4f113dac5504bd27232eec654934c7f92f)) ### [`v17.4.0`](https://togithub.com/octokit/rest.js/releases/v17.4.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.3.0...v17.4.0) ##### Features - octokit.actions.deleteWorkflowRunLogs() ([#1673](https://togithub.com/octokit/rest.js/issues/1673)) ([0386dad](https://togithub.com/octokit/rest.js/commit/0386dad85d469fbc421901a22ccd31f69fa34572)) ### [`v17.3.0`](https://togithub.com/octokit/rest.js/releases/v17.3.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.2.1...v17.3.0) ##### Features - simpler pagination using endpoint methods as first argument ([#1672](https://togithub.com/octokit/rest.js/issues/1672)) ([548d65a](https://togithub.com/octokit/rest.js/commit/548d65ab6cd44d770bbec913dedb523d2ba52118)) Before ```js const options = octokit.issues.listForRepo.endpoint.merge({ owner: "octokit", repo: "rest.js", }); const issues = await octokit.paginate(options); ``` After ```js const issues = await octokit.paginate(octokit.issues.listForRepo, { owner: "octokit", repo: "rest.js", }); ``` ### [`v17.2.1`](https://togithub.com/octokit/rest.js/releases/v17.2.1) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.2.0...v17.2.1) ##### Bug Fixes - **TypeScript:** method description updates ([#1671](https://togithub.com/octokit/rest.js/issues/1671)) ([3fba786](https://togithub.com/octokit/rest.js/commit/3fba786c32c5a77dd7e6842dca7f8f6dbe06b87d)) ### [`v17.2.0`](https://togithub.com/octokit/rest.js/releases/v17.2.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.1.4...v17.2.0) ##### Features - maintain and triage user permissions in orgs, gambit preview graduated ([#32](https://togithub.com/octokit/rest.js/issues/32)) ([#1665](https://togithub.com/octokit/rest.js/issues/1665)) ([76f7fbe](https://togithub.com/octokit/rest.js/commit/76f7fbe61af930294e55c3883284e14d0948f8c6)) ### [`v17.1.4`](https://togithub.com/octokit/rest.js/releases/v17.1.4) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.1.3...v17.1.4) ##### Renames The previous methods have been deprecated. - `octokit.activity.checkStarringRepo()` -> `octokit.activity.checkRepoIsStarredByAuthenticatedUser()` - `octokit.activity.listEventsForOrg()` -> `octokit.activity.listOrgEventsForAuthenticatedUser()` - `octokit.activity.listEventsForUser()` -> `octokit.activity.listEventsForAuthenticatedUser()` - `octokit.activity.listFeeds()` -> `octokit.activity.getFeeds()` - `octokit.activity.listNotifications()` -> `octokit.activity.listNotificationsForAuthenticatedUser()` - `octokit.activity.listNotificationsForRepo()` -> `octokit.activity.listRepoNotificationsForAuthenticatedUser()` - `octokit.activity.listPublicEventsForOrg()` -> `octokit.activity.listPublicOrgEvents()` - `octokit.activity.markAsRead()` -> `octokit.activity.markNotificationsAsRead()` - `octokit.activity.markNotificationsAsReadForRepo()` -> `octokit.activity.markRepoNotificationsAsRead()` - `octokit.activity.starRepo()` -> `octokit.activity.starRepoForAuthenticatedUser()` - `octokit.activity.unstarRepo()` -> `octokit.activity.unstarRepoForAuthenticatedUser()` ### [`v17.1.3`](https://togithub.com/octokit/rest.js/releases/v17.1.3) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.1.2...v17.1.3) ##### Bug Fixes - update [@octokit/plugin-rest-endpoint-methods](https://togithub.com/octokit/plugin-rest-endpoint-methods) to version 3.3.3 and pin versino in package.json ([a492db4](https://togithub.com/octokit/rest.js/commit/a492db42786e2be8111b36bd976116d4b4fb0a39)), closes [#1657](https://togithub.com/octokit/rest.js/issues/1657) ### [`v17.1.2`](https://togithub.com/octokit/rest.js/releases/v17.1.2) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.1.1...v17.1.2) ##### Bug Fixes - update `Octokit.plugin()` API to remove deprecation ([1c1df88](https://togithub.com/octokit/rest.js/commit/1c1df88f8936b456c8c00691f9392fd1b913f51f)), closes [#1654](https://togithub.com/octokit/rest.js/issues/1654) ### [`v17.1.1`](https://togithub.com/octokit/rest.js/releases/v17.1.1) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.1.0...v17.1.1) ##### Bug Fixes - **types:** export Octokit type ([#1650](https://togithub.com/octokit/rest.js/issues/1650)) ([1b708ce](https://togithub.com/octokit/rest.js/commit/1b708ce41ef12a9d4ae313e8872e8fd14d285f98)) ### [`v17.1.0`](https://togithub.com/octokit/rest.js/releases/v17.1.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.0.1...v17.1.0) ##### Features - `octokit.repos.deleteDeployment()` - `octokit.actions.listArtifactsForRepo()` - new octokit.reactions.\* endpoints. Deprecates `octokit.reactions.delete()` - new endpoints and deprecations coming from restructuring in GitHubs REST API docs ### [`v17.0.1`](https://togithub.com/octokit/rest.js/releases/v17.0.1) [Compare Source](https://togithub.com/octokit/rest.js/compare/v17.0.0...v17.0.1) ##### Bug Fixes - load all plugins while preserving type information provided to Octokit ([#1638](https://togithub.com/octokit/rest.js/issues/1638)) ([1bdd177](https://togithub.com/octokit/rest.js/commit/1bdd1770ad6f91c3acd6287fab752567c159bdfb)) ### [`v17.0.0`](https://togithub.com/octokit/rest.js/releases/v17.0.0) [Compare Source](https://togithub.com/octokit/rest.js/compare/v16.43.1...v17.0.0) ##### Breaking Changes - All deprecated methods and options have been removed. Upgrade to the latest `16.x.x` version and address all deprecation messages for an easy upgrade. - For deprecated endpoint methods that have no replacement use `octokit.request` instead. - **`octokit.oauthAuthorizations.createAuthorization()`** ➡ `octokit.request("POST /authorizations", parameters)` ([see deprecation notice](https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization)) - **`octokit.oauthAuthorizations.deleteAuthorization()`** ➡ `octokit.request("DELETE /authorizations/:authorization_id", parameters)` ([see deprecation notice](https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization)) - **`octokit.oauthAuthorizations.deleteGrant()`** ➡ `octokit.request("DELETE /applications/grants/:grant_id", parameters)` ([see deprecation notice](https://developer.github.com/v3/oauth_authorizations/#delete-a-grant)) - **`octokit.oauthAuthorizations.getAuthorization()`** ➡ `octokit.request("GET /authorizations/:authorization_id", parameters)` ([see deprecation notice](https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization)) - **`octokit.oauthAuthorizations.getGrant()`** ➡ `octokit.request("GET /applications/grants/:grant_id", parameters)` ([see deprecation notice](https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant)) - **`octokit.oauthAuthorizations.getOrCreateAuthorizationForApp()`** ➡ `octokit.request("PUT /authorizations/clients/:client_id", parameters)` ([see deprecation notice](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app)) - **`octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint()`** ➡ `octokit.request("PUT /authorizations/clients/:client_id/:fingerprint", parameters)` ([see deprecation notice](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint)) - **`octokit.oauthAuthorizations.listAuthorizations()`** ➡ `octokit.request("GET /authorizations", parameters)` ([see deprecation notice](https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations)) - **`octokit.oauthAuthorizations.listGrants()`** ➡ `octokit.request("GET /applications/grants", parameters)` ([see deprecation notice](https://developer.github.com/v3/oauth_authorizations/#list-your-grants)) - **`octokit.oauthAuthorizations.updateAuthorization()`** ➡ `octokit.request("PATCH /authorizations/:authorization_id", parameters)` ([see deprecation notice](https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization)) - **`octokit.pulls.createFromIssue()`** ➡ `octokit.request("POST /repos/:owner/:repo/pulls", parameters)` ([see deprecation notice](https://developer.github.com/v3/pulls/#create-a-pull-request)) - **`octokit.repos.getCommitRefSha()`** ➡ `octokit.request("GET /repos/:owner/:repo/commits/:ref", parameters)` ([see deprecation notice](https://developer.github.com/v3/repos/commits/#get-a-single-commit)) - **`octokit.teams.addMemberLegacy()`** ➡ `octokit.request("PUT /teams/:team_id/members/:username", parameters)` ([see deprecation notice](https://developer.github.com/v3/teams/members/#add-team-member-legacy)) - **`octokit.teams.getLegacy()`** ➡ `octokit.request("GET /teams/:team_id", parameters)` ([see deprecation notice](https://developer.github.com/v3/teams/#get-team-legacy)) - **`octokit.teams.getMemberLegacy()`** ➡ `octokit.request("GET /teams/:team_id/members/:username", parameters)` ([see deprecation notice](https://developer.github.com/v3/teams/members/#get-team-member-legacy)) - **`octokit.teams.removeMemberLegacy()`** ➡ `octokit.request("DELETE /teams/:team_id/members/:username", parameters)` ([see deprecation notice](https://developer.github.com/v3/teams/members/#remove-team-member-legacy)) - Methods have been replaced by new ones, some of which require new parameters - **`octokit.apps.checkAuthorization()`** ➡ `octokit.apps.checkToken()` - **`octokit.apps.resetAuthorization()`** ➡ `octokit.apps.resetToken()` - **`octokit.apps.revokeAuthorizationForApplication()`** ➡ `octokit.apps.deleteToken()` - **`octokit.apps.revokeGrantForApplication()`** ➡ `octokit.apps.deleteAuthorization()` - **`octokit.reactions.createForTeamDiscussionLegacy()`** ➡ `octokit.reactions.createForTeamDiscussionInOrg()` (An "org" parameter is now required) - **`octokit.reactions.createForTeamDiscussionCommentLegacy()`** ➡ `octokit.reactions.createForTeamDiscussionCommentInOrg()` (An "org" parameter is now required) - **`octokit.reactions.listForTeamDiscussionLegacy()`** ➡ `octokit.reactions.listForTeamDiscussionInOrg()` (An "org" parameter is now required) - **`octokit.reactions.listForTeamDiscussionCommentLegacy()`** ➡ `octokit.reactions.listForTeamDiscussionCommentInOrg()` (An "org" parameter is now required) - **`octokit.teams.addMemberLegacy()`** ➡ `octokit.teams.addMemberInOrg()` (An "org" parameter is now required) - **`octokit.teams.addOrUpdateMembershipLegacy()`** ➡ `octokit.teams.addOrUpdateMembershipInOrg()` (An "org" parameter is now required) - **`octokit.teams.addOrUpdateProjectLegacy()`** ➡ `octokit.teams.addOrUpdateProjectInOrg()` (An "org" parameter is now required) - **`octokit.teams.addOrUpdateRepoLegacy()`** ➡ `octokit.teams.addOrUpdateRepoInOrg()` (An "org" parameter is now required) - **`octokit.teams.checkManagesRepoLegacy()`** ➡ `octokit.teams.checkManagesRepoInOrg()` (An "org" parameter is now required) - **`octokit.teams.createDiscussionLegacy()`** ➡ `octokit.teams.createDiscussionInOrg()` (An "org" parameter is now required) - **`octokit.teams.createDiscussionCommentLegacy()`** ➡ `octokit.teams.createDiscussionCommentInOrg()` (An "org" parameter is now required) - **`octokit.teams.deleteLegacy()`** ➡ `octokit.teams.deleteInOrg()` (An "org" parameter is now required) - **`octokit.teams.deleteDiscussionLegacy()`** ➡ `octokit.teams.deleteDiscussionInOrg()` (An "org" parameter is now required) - **`octokit.teams.deleteDiscussionCommentLegacy()`** ➡ `octokit.teams.deleteDiscussionCommentInOrg()` (An "org" parameter is now required) - **`octokit.teams.getLegacy()`** ➡ `octokit.teams.getInOrg()` (An "org" parameter is now required) - **`octokit.teams.getDiscussionLegacy()`** ➡ `octokit.teams.getDiscussionInOrg()` (An "org" parameter is now required) - **`octokit.teams.getDiscussionCommentLegacy()`** ➡ `octokit.teams.getDiscussionCommentInOrg()` (An "org" parameter is now required) - **`octokit.teams.getMemberLegacy()`** ➡ `octokit.teams.getMemberInOrg()` (An "org" parameter is now required) - **`octokit.teams.getMembershipLegacy()`** ➡ `octokit.teams.getMembershipInOrg()` (An "org" parameter is now required) - **`octokit.teams.listChildLegacy()`** ➡ `octokit.teams.listChildInOrg()` (An "org" parameter is now required) - **`octokit.teams.listDiscussionCommentsLegacy()`** ➡ `octokit.teams.listDiscussionCommentsInOrg()` (An "org" parameter is now required) - **`octokit.teams.listDiscussionsLegacy()`** ➡ `octokit.teams.listDiscussionsInOrg()` (An "org" parameter is now required) - **`octokit.teams.listMembersLegacy()`** ➡ `octokit.teams.listMembersInOrg()` (An "org" parameter is now required) - **`octokit.teams.listPendingInvitationsLegacy()`** ➡ `octokit.teams.listPendingInvitationsInOrg()` (An "org" parameter is now required) - **`octokit.teams.listProjectsLegacy()`** ➡ `octokit.teams.listProjectsInOrg()` (An "org" parameter is now required) - **`octokit.teams.listReposLegacy()`** ➡ `octokit.teams.listReposInOrg()` (An "org" parameter is now required) - **`octokit.teams.removeMemberLegacy()`** ➡ `octokit.teams.removeMemberInOrg()` (An "org" parameter is now required) - **`octokit.teams.removeMembershipLegacy()`** ➡ `octokit.teams.removeMembershipInOrg()` (An "org" parameter is now required) - **`octokit.teams.removeProjectLegacy()`** ➡ `octokit.teams.removeProjectInOrg()` (An "org" parameter is now required) - **`octokit.teams.removeRepoLegacy()`** ➡ `octokit.teams.removeRepoInOrg()` (An "org" parameter is now required) - **`octokit.teams.reviewProjectLegacy()`** ➡ `octokit.teams.reviewProjectInOrg()` (An "org" parameter is now required) - **`octokit.teams.updateLegacy()`** ➡ `octokit.teams.updateInOrg()` (An "org" parameter is now required) - **`octokit.teams.updateDiscussionLegacy()`** ➡ `octokit.teams.updateDiscussionInOrg()` (An "org" parameter is now required) - **`octokit.teams.updateDiscussionCommentLegacy()`** ➡ `octokit.teams.updateDiscussionCommentInOrg()` (An "org" parameter is now required) - **`octokit.issues.updateLabel({current_name, name})`** ➡ `octokit.issues.updateLabel({name, new_name})` (`current_name` is now `name`, `name` is now `new_name`) - `octokit.paginate()` is now always returning an array, even when the response is a single object. - Parameters passed to endpoint methods such as `octokit.issues.create(parameters)` are no longer validated on the client. We recommend using TypeScript or taking advantage of the TypeScript definitions in JavaScript. - Plugins have to return an object in order to extend the `octokit` instance. It is technically still possible to alter the `octokit` instance directly, but returning an object is required for TypeScript support Instead of ```js function myPlugin(octokit, options) { octokit.helloWorld = () => console.log('Hello, world!') } ``` do ```js function myPlugin(octokit, options) { return { helloWorld: () => console.log('Hello, world!') } } ``` - `octokit.registerEndpoints()` has been removed. Instead of ```js await octokit.registerEndpoints({ misc: { getRoot: { method: "GET", url: "/" } } }); ``` do ```js Object.assign(octokit.misc, { getRoot: octokit.request.defaults({ method: "GET", url: "/" }) }) ``` If you use `octokit.registerEndpoints()` in a plugin, return an object instead: ```js function myPlugin(octokit, options) { return { misc: { octokit.request.defaults({ method: "GET", url: "/" }) } } } ``` - The `User-Agent` header now includes `octokit-rest.js/X.Y.Z` instead of `octokit.js/X.Y.Z` - The `Octokit` constructor must now be invoked with `new`. `const octokit = Octokit()` will throw a TypeError - Node 8 is no longer supported. - ~~**TypeScript:** The exported `{ Octokit }` is no longer a type, only a value. Use `typeof Octokit` instead [#1624](https://togithub.com/octokit/rest.js/issues/1624)~~ **Update**: resolved via [#1650](https://togithub.com/octokit/rest.js/issues/1650) ##### Features - The documentation website is now versioned.Renovate configuration
:date: Schedule: At any time (no schedule defined).
:vertical_traffic_light: Automerge: Disabled by config. Please merge this manually once you are satisfied.
:recycle: Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
:no_bell: Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by WhiteSource Renovate. View repository job log here.