Skip to content

v5.0.0

Choose a tag to compare

@github-actions github-actions released this 06 Oct 02:52

BREAKING CHANGES

  • .git.getTree(): recursive parameter must now be a '1' instead of 1. It's due to the new way files are generated, working around it is not worth the effort

  • .pulls.createComment has been removed for GHE 2.17 and below. This has been resolved with GHE 2.18. The problem is that the endpoint accepts different inputs which before resulted in two different methods. With the new OpenAPI specification of octokit/routes, this can no longer be ... specified (at least not without a lot of extra effort). So sorry for that. You can create a pull request comment using octokit.request() instead:

    octokit.request('POST /repos/:owner/:repo/pulls/:pull_number/comments', {
      owner,
      repo,
      pull_number,
      commit_id,
      path,
      position,
    })

FEATUERS

  • GitHub Enterprise Server 2.18 (17a7d24)
  • repos.getTeamsWithAccessToProtectedBranch()
  • repos.getUsersWithAccessToProtectedBranch()

DEPRECATIONS

  • pulls.createFromIssue() is deprecated and will be removed in future. Use pulls.create() instead
  • teams.addMember(), teams.getMember(), teams.removeMember()

FIXES

  • incorrect pagination parameters removed from .projects.createForAuthenticatedUser, .projects.createForOrg, .projects.createForRepo and .projects.update
  • repos.updateBranchProtection(): teams and users keys are now required for the restrictions parameter
  • teams.update({privacy}) option is now an enum and only allows secret or closed