Node 10 is no longer supported.
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.
All deprecated methods and options have been removed. Upgrade to the latest 2.x.x version and address all deprecation messages for an easy upgrade.
- For deprecated endpoint methods that have no replacement, you can fall back to octokit.request(). Note that this is only a temporary solution, as the REST API endpoints will be removed in future.
  - 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)
    ...

Assets 2

06 Feb 21:04

github-actions

v3.0.0-beta.3

6e79bf6

v3.0.0-beta.3 Pre-release

Pre-release

3.0.0-beta.3 (2020-02-06)

Features

deprecate octokit.gitdata.*, octokit.pullRequests.* (f62b1ee)
octokit.actions.listDownloadsForSelfHostedRunnerApplication() (aab7d1d)

Assets 2

03 Feb 06:05

github-actions

v2.4.0

f62b1ee

v2.4.0

2.4.0 (2020-02-03)

Features

deprecate octokit.gitdata.*, octokit.pullRequests.* (f62b1ee)

Assets 2

02 Feb 21:18

github-actions

v3.0.0-beta.2

8f25a16

v3.0.0-beta.2 Pre-release

Pre-release

Features

octokit.actions.listDownloadsForSelfHostedRunnerApplication({ owner, repo }) (8f25a16)

Bug Fixes

map contexts/users/teams etc parameters to data for branch protection endpoints (d48f560)

Assets 2

02 Feb 21:09

github-actions

v2.3.0

aab7d1d

v2.3.0

2.3.0 (2020-02-02)

Features

octokit.actions.listDownloadsForSelfHostedRunnerApplication() (aab7d1d)

Assets 2

31 Jan 22:26

github-actions

v3.0.0-beta.1

3774640

v3.0.0-beta.1 Pre-release

Pre-release

BREAKING CHANGES

Node 8 is out of maintenance since Jan 2020. We no longer test against it
remainging deprecated endpoint methods removed.
All *Legacy methods have been removed. They have all been deprecated in the previous version
all previously deprecated methods and parameters have been removed.
octokit.registerEndpoints() has been removed.

Instead of

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

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

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

octokit.issues.updateLabel({ current_name, name}) is now octokit.issues.updateLabel({ name, new_name})
octokit.pulls.createFromIssue removed. The API endpoint is deprecated and will be removed in future
, octokit.git.listRefs removed. Use octokit.git.listMatchingRefs() instead.
octokit.repos.getCommitRefSha removed. Use octokit.repos.getCommit({ mediaType: { format: "sha" }, owner, repo, ref }) instead

Assets 2

Releases: octokit/plugin-rest-endpoint-methods.js

v3.2.0

3.2.0 (2020-02-21)

Features

Uh oh!

v3.1.1

3.1.1 (2020-02-18)

Bug Fixes

Uh oh!

v3.1.0

3.1.0 (2020-02-18)

Features

Uh oh!

v3.0.1

3.0.1 (2020-02-13)

Bug Fixes

Uh oh!

v3.0.0

Breaking Changes

Uh oh!

v3.0.0-beta.3

3.0.0-beta.3 (2020-02-06)

Features

Uh oh!

v2.4.0

2.4.0 (2020-02-03)

Features

Uh oh!

v3.0.0-beta.2

Features

Bug Fixes

Uh oh!

v2.3.0

2.3.0 (2020-02-02)

Features

Uh oh!

v3.0.0-beta.1

BREAKING CHANGES

Uh oh!