Update dependency @octokit/rest to v17 #71

renovate · 2020-03-28T02:45:15Z

This PR contains the following updates:

Package	Type	Update	Change
@octokit/rest	dependencies	major	`^16.25.0` -> `^17.0.0`

Release Notes

octokit/rest.js

`v17.1.4`

Compare Source

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`

Compare Source

Bug Fixes

update @octokit/plugin-rest-endpoint-methods to version 3.3.3 and pin versino in package.json (a492db4), closes #1657

`v17.1.2`

Compare Source

Bug Fixes

update Octokit.plugin() API to remove deprecation (1c1df88), closes #1654

`v17.1.1`

Compare Source

Bug Fixes

types: export Octokit type (#1650) (1b708ce)

`v17.1.0`

Compare Source

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`

Compare Source

Bug Fixes

load all plugins while preserving type information provided to Octokit (#1638) (1bdd177)

`v17.0.0`

Compare Source

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)
  - octokit.oauthAuthorizations.deleteAuthorization()
    ➡ octokit.request("DELETE /authorizations/:authorization_id", parameters)
    (see deprecation notice)
  - octokit.oauthAuthorizations.deleteGrant()
    ➡ octokit.request("DELETE /applications/grants/:grant_id", parameters)
    (see deprecation notice)
  - octokit.oauthAuthorizations.getAuthorization()
    ➡ octokit.request("GET /authorizations/:authorization_id", parameters)
    (see deprecation notice)
  - octokit.oauthAuthorizations.getGrant()
    ➡ octokit.request("GET /applications/grants/:grant_id", parameters)
    (see deprecation notice)
  - octokit.oauthAuthorizations.getOrCreateAuthorizationForApp()
    ➡ octokit.request("PUT /authorizations/clients/:client_id", parameters)
    (see deprecation notice)
  - octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint()
    ➡ octokit.request("PUT /authorizations/clients/:client_id/:fingerprint", parameters)
    (see deprecation notice)
  - octokit.oauthAuthorizations.listAuthorizations()
    ➡ octokit.request("GET /authorizations", parameters)
    (see deprecation notice)
  - octokit.oauthAuthorizations.listGrants()
    ➡ octokit.request("GET /applications/grants", parameters)
    (see deprecation notice)
  - octokit.oauthAuthorizations.updateAuthorization()
    ➡ octokit.request("PATCH /authorizations/:authorization_id", parameters)
    (see deprecation notice)
  - octokit.pulls.createFromIssue()
    ➡ octokit.request("POST /repos/:owner/:repo/pulls", parameters)
    (see deprecation notice)
  - octokit.repos.getCommitRefSha()
    ➡ octokit.request("GET /repos/:owner/:repo/commits/:ref", parameters)
    (see deprecation notice)
  - octokit.teams.addMemberLegacy()
    ➡ octokit.request("PUT /teams/:team_id/members/:username", parameters)
    (see deprecation notice)
  - octokit.teams.getLegacy()
    ➡ octokit.request("GET /teams/:team_id", parameters)
    (see deprecation notice)
  - octokit.teams.getMemberLegacy()
    ➡ octokit.request("GET /teams/:team_id/members/:username", parameters)
    (see deprecation notice)
  - octokit.teams.removeMemberLegacy()
    ➡ octokit.request("DELETE /teams/:team_id/members/:username", parameters)
    (see deprecation notice)
- 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

function myPlugin(octokit, options) {
  octokit.helloWorld = () => console.log('Hello, world!')
}

do

function myPlugin(octokit, options) {
  return {
    helloWorld: () => console.log('Hello, world!')
  }
}

octokit.registerEndpoints() has been removed.

Instead of

await octokit.registerEndpoints({
  misc: {
    getRoot: {
      method: "GET",
      url: "/"
    }
  }
});

do

Object.assign(octokit.misc, {
  getRoot: octokit.request.defaults({
    method: "GET",
    url: "/"
  })
})

If you use octokit.registerEndpoints() in a plugin, return an object instead:

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 Update: resolved via #1650

Features

The documentation website is now versioned. https://octokit.github.io/rest.js/v17/ has the docs for the latest version, the docs for v16 are still accessible at https://octokit.github.io/rest.js/v16. Old links pointing to https://octokit.github.io/rest.js should redirect correctly to https://octokit.github.io/rest.js/v16.
reduction in bundle size: 23KB down to 10kb
octokit.graphql(). @octokit/rest is no longer a REST-only library, but a REST best-practice library. All Octokit libraries based on @ocotkit/core have both .request() and .graphql() methods.
octokit.auth(). Async method that returns the currently used authentcation, based on configured authStrategy. See https://github.com/octokit/auth.js#readme for official strategies
octokit.repos.uploadReleaseAsset(parameters) now accepts URL parameters
- owner
- repo
- release_id
Passing url will still work, but is not recommended. Use octokit.request instead:
```
octokit.request(url, {
  method: "POST",
  ...parameters
})
```

✨🦄

48,624 lines of code down to 10. As in 10. Not 10,000. 10.

Renovate configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR has been generated by WhiteSource Renovate. View repository job log here.

Update dependency @octokit/rest to v17

30ceb9f

foxundermoon merged commit f20d708 into master Mar 28, 2020

foxundermoon deleted the renovate/octokit-rest-17.x branch March 28, 2020 02:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update dependency @octokit/rest to v17 #71

Update dependency @octokit/rest to v17 #71

renovate bot commented Mar 28, 2020

Update dependency @octokit/rest to v17 #71

Update dependency @octokit/rest to v17 #71

Conversation

renovate bot commented Mar 28, 2020

Release Notes

v17.1.4

Renames

v17.1.3

Bug Fixes

v17.1.2

Bug Fixes

v17.1.1

Bug Fixes

v17.1.0

Features

v17.0.1

Bug Fixes

v17.0.0

Breaking Changes

Features

✨🦄

Renovate configuration

`v17.1.4`

`v17.1.3`

`v17.1.2`

`v17.1.1`

`v17.1.0`

`v17.0.1`

`v17.0.0`