Skip to content

v3.0.0-beta.1

Pre-release
Pre-release
Compare
Choose a tag to compare
@github-actions github-actions released this 31 Jan 22:26

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: "/"
    }
  }
});

do

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

or

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