fix(deps): update dependency @octokit/rest to v17 #7

renovate · 2020-03-14T12:00:41Z

This PR contains the following updates:

Package	Type	Update	Change
@octokit/rest	dependencies	major	`16.2.0` -> `17.1.0`

Release Notes

octokit/rest.js

`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

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.

`v16.43.1`

Compare Source

Bug Fixes

TypeScript: named { Octokit } export (486eadd)

`v16.43.0`

Compare Source

Features

deprecate octokit.gitdata.*, octokit.pullRequests.* (#1585) (989afc1)

`v16.42.2`

Compare Source

Bug Fixes

recover Octokit.plugin (7b316d8)

`v16.42.1`

Compare Source

Bug Fixes

do not throw if using deprecated Octokit default export without options (dec7334)

`v16.42.0`

Compare Source

Features

deprecate const Octokit = require("@octokit/rest") in favor of const { Octokit } = require("@octokit/rest") (bbc3e48)

Bug Fixes

package: update @octokit/plugin-rest-endpoint-methods to version 2.2.0 (3539118)
Typescript: since parameter type is integer, not string (6285b6c)
TypeScript: file parameter is no data for .repos.uploadReleaseAsset() (dc2cc51)

`v16.41.0`

Compare Source

Features

typescript: types for latest Action endpoint methods (#1567) (0758d61)

`v16.40.2`

Compare Source

Bug Fixes

typescript: new auth strategy options (0c7b109)

`v16.40.1`

Compare Source

Bug Fixes

typescript: descripion & response types fixes (#1561) (7c64d9c)

`v16.40.0`

Compare Source

Features

Actions endpoint methdos (a706b0d)

`v16.39.0`

Compare Source

Features

accessing response.data[namespacekey] in .paginate(options, mapFn) map function now logs a deprecation (3caa24a)

`v16.38.3`

Compare Source

Bug Fixes

typescript: .git.getTree types (#1556) (39cdce8)

`v16.38.2`

Compare Source

Bug Fixes

everest preview graduated (441c452)
add .endpoint() method to all deprecated endpoint methods (9701151)
bring back octokit.teams.removeMember() (d439ca7)
bring back `octokit.teams.removeMembership() (dadfe9a)
correct deprecation message for octokit.apps.* OAuth authorization methods' (5f5e62e)

`v16.38.1`

Compare Source

Bug Fixes

typescript: authStrategy key in Octokit constructor options (fb19f11)

`v16.38.0`

Compare Source

Features

All authentication strategies from @octokit/auth are now supported. Setting auth to an object or a basic authentication string is now deprecated and will be removed in v17 (4573ee2)

`v16.37.0`

Compare Source

Features

.apps.revokeInstallationToken() (ed31137)
.migrations.listReposForOrg(), .migrations.listReposForUser() (8777073)
.repos.listForOrg()'s type parameter can now be set to "internal" (GitHub Enterprise Cloud only) (9c71d18)
visibility parameter for .repos.createForAuthenticatedUser() and .repos.createInOrg() (31b094b)
new delete_branch_on_merge parameter for .repos.createForAuthenticatedUser(), .repos.createInOrg(), .repos.update() (c783249)
new parameters for .orgs.update(): members_can_create_internal_repositories, members_can_create_private_repositories, members_can_create_public_repositories (7be5174)
new parameters for .repos.updateBranchProtection(): allow_deletions, allow_force_pushes, required_linear_history (c5632ff)
rename & deprecation of endpoint methods using /teams/:team_id* path internally. The are being replaced by *ForOrg methods that use /orgs/:org/teams/:team_slug* internally. With the next breaking version, the *ForOrg suffix will be removed using another deprecation. (faecc99)

Bug Fixes

graduated previews removed: barred-rock, echo, hagar (53b8021)

`v16.36.0`

Compare Source

Features

typescript: deprecate client options (#1538) (0ce7f60)

`v16.35.2`

Compare Source

Bug Fixes

correct typo in test/util.js (#1523) (2bd7da9)

`v16.35.1`

Compare Source

Bug Fixes

submitted_at for pr review (#1519) (b4e5f67)

`v16.35.0`

Compare Source

Features

.apps.checkAuthorization()
.apps.checkToken()
.apps.deleteAuthorization()
.apps.deleteToken()
.apps.resetAuthorization()
.apps.resetToken()
.apps.revokeAuthorizationForApplication()
.apps.revokeGrantForApplication()

Deprecations

.apps.checkAuthorization()
.apps.resetAuthorization()
.apps.revokeAuthorizationForApplication()
.apps.revokeGrantForApplication()
.oauthAuthorizations.checkAuthorization
.oauthAuthorizations.createAuthorization
.oauthAuthorizations.deleteAuthorization
.oauthAuthorizations.deleteGrant
.oauthAuthorizations.getAuthorization
.oauthAuthorizations.getGrant
.oauthAuthorizations.getOrCreateAuthorizationForApp
.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint
.oauthAuthorizations.listAuthorizations
.oauthAuthorizations.listGrants
.oauthAuthorizations.resetAuthorization
.oauthAuthorizations.revokeAuthorizationForApplication
.oauthAuthorizations.revokeGrantForApplication
.oauthAuthorizations.updateAuthorization

See also: https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api/

Fixes

.repos.listTopics() & .repos.replaceTopics(): required mercy preview header set by default

`v16.34.1`

Compare Source

Bug Fixes

typescript: Include done callback in Paginate interface (6e2051b)

`v16.34.0`

Compare Source

Bug Fixes

remove obsolete plugin to normalize git reference responses (3933c24)

Features

multi-line review comments, client_payload parameter for creating a repository dispatch event, listing installations for an organization (e891d4e)

`v16.33.1`

Compare Source

Bug Fixes

include details in server validation error (#1499) (1794917)

`v16.33.0`

Compare Source

Features

options: add timeZone option (8a1fb13)

`v16.32.0`

Compare Source

Features

types: add deprecation jsdoc for deprecated methods (f7c31af)
types: mark params deprecated if description has 'deprecated' (ffe9aaa)

`v16.31.0`

Compare Source

Bug Fixes

index.js: remove unused scope query field (58443cd)

Features

deprecated: Show a message for deprecated methods (453ebcc)

`v16.30.2`

Compare Source

Bug Fixes

search: remove extra octokit prefix (07514ae), closes #1481

`v16.30.1`

Compare Source

Bug Fixes

typescript: allow mediaType option in endpoint methods (be7e388), closes probot/probot#1024

`v16.30.0`

Compare Source

Features

octokit.pulls.createFromIssue()` is deprecated. Useoctokit.pulls.create()` instead (6f939ad)

`v16.29.0`

Compare Source

Bug Fixes

luke-cage header is not required (9926988)
restrictions.teams and restrictions.users are required for `octokit.repos.updateBranchProtection() (d68aa77)
add deprecation messages for octokit.teams.{add,get,remove}Member() (f4e0a1b)
add enum for privacy parameter for octokit.teams.edit() (71ba2ae)
alias for "sha" is "ref" for octokit.repos.getCommit() (9164417)
remove incorrect page/per_page parameters from PATCh requests (6395735)
remove incorrect page/per_page parameters from POST requests (a7a45ac)
remove unused page and per_page parameters from octokit.repos.listProtectedBranchTeamRestrictions() (3c04006)
set "luke-cage" preview request for branch protection endpoint methods (6a3d318)
validate enum values always as strings (22fb9ab)

Features

octokit.pulls.createReviewCommentReply() (c7831d3)
deprecation: octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (b59f0b5)
deprecation: octokit.repos.listProtectedBranchTeamRestrictions & octokit.repos.listTeamsWithAccessToProtectedBranch -> octokit.repos.getTeamsWithAccessToProtectedBranch (9e3b5b1)
deprecation: octokit.repos.listProtectedBranchUserRestrictions & octokit.repos.listUsersWithAccessToProtectedBranch -> octokit.repos.getUsersWithAccessToProtectedBranch (5896712)
octokit.repos.addProtectedBranchAppRestrictions(), octokit.repos.removeProtectedBranchAppRestrictions(), octokit.repos.replaceProtectedBranchAppRestrictions() (542c7e7)
octokit.repos.createDispatchEvent() (eee4ae6)
octokit.repos.listAppsWithAccessToProtectedBranch() -> octokit.repos.getAppsWithAccessToProtectedBranch() (4d4fe03)

`v16.28.9`

Compare Source

Bug Fixes

package: update universal-user-agent to version 4.0.0 (b5a96a9)

`v16.28.8`

Compare Source

Bug Fixes

package: remove unused url-template dependency (484eccd)

`v16.28.7`

Compare Source

Bug Fixes

normalize pagination for "List installations for a user" endpoint (#1440) (7b51cee)

`v16.28.6`

Compare Source

Bug Fixes

name parameter is not required for .repos.update() (#1435) (494d75b)

`v16.28.5`

Compare Source

Bug Fixes

"owner" parameter is no longer conflicting in octokit.repos.createUsingTemplate() (#1431) (fe605fe)

`v16.28.4`

Compare Source

Bug Fixes

package: update universal-user-agent to version 3.0.0 (a579ae5)

`v16.28.3`

Compare Source

Bug Fixes

package: before-after-hook at v2.0.0 (ac07de4)
package: update @octokit/request to version 5.0.0 (9685a71)

`v16.28.2`

Compare Source

Bug Fixes

typo in deprecation warnings (#1402) (a96f5d6)

`v16.28.1`

Compare Source

Bug Fixes

add "rocket" and "eyes" to set of supported reactions (69462e0)

`v16.28.0`

Compare Source

Features

commit_sha parameter forrepos.listCommentsForCommit()andrepos.createCommitComment()` (1e7c3a8)
repos.createOrUpdateFile() (63a5e99)
repos.enableAutomatedSecurityFixes() and repos.disableAutomatedSecurityFixes() (ebab182)
repos.updateBranch() (5ba501e)

`v16.27.3`

Compare Source

Bug Fixes

typescript: Octokit#plugin argument type for plugins (#1385) (05bc206)

`v16.27.2`

Compare Source

Bug Fixes

author.* and committer.* parameter validation for .repos.deleteFile() (#1384) (2155b1a)

`v16.27.1`

Compare Source

Bug Fixes

typo in deprecation message for .repos.getCommitRefSha() (ade2d00)

`v16.27.0`

Compare Source

Features

octokit.repos.getCommitRefSha() is deprecated, use octokit.repos.getCommit() instead (9e0aeaf)

`v16.26.0`

Compare Source

Features

.repos.enableVulnerabilityAlerts()
.repos.disableVulnerabilityAlerts()

Fixes

source parameter for .repos.enablePagesSite()

`v16.25.6`

Compare Source

Bug Fixes

package: update @octokit/request to version 4.0.1 (cf5efd8)

`v16.25.5`

Compare Source

Bug Fixes

package: update deprecation to version 2.0.0 (06af662)

`v16.25.4`

Compare Source

Bug Fixes

package: update @octokit/request to version 3.0.3 (0620584)

`v16.25.3`

Compare Source

Bug Fixes

package: update @octokit/request to version 3.0.2 (6a54819)

`v16.25.2`

Compare Source

Bug Fixes

do not mutate options passed to endpoint methods (fe51f06)

`v16.25.1`

Compare Source

Bug Fixes

package: update @octokit/request to version 3.0.1 (53988ad)

`v16.25.0`

Compare Source

Features

apps.deleteInstallation({ installation_id }) (#1342) (4045f1a)

`v16.24.3`

Compare Source

Bug Fixes

throw 400 Bad Request error when octokit.issues.get() without parameters (a102378)

`v16.24.2`

Compare Source

Bug Fixes

implement deprecation for parameters in .endpoint() and .endpoint.merge() (8cebbfa)

`v16.24.1`

Compare Source

Features

:commit_sha parameter for .git.getCommit(). Deprecates :sha (1b98f9c)
:issue_number, :milestone_number, :pull_number parameters. Deprecates :number (87dc7c6)
.repos.listBranchesForHeadCommit() (473642d)
.repos.listPullRequestsAssociatedWithCommit() (4a74d40)

Bug Fixes

parameter deprecation bug (#1323) (f1b9dea)

`v16.24.0`

Compare Source

⚠️ This release has a bug, see #1323

Update to v16.24.1 instead.

`v16.23.5`

Compare Source

Bug Fixes

.paginate() with results namespace (GET /installation/repositories, single page response) (27e2977)

`v16.23.4`

Compare Source

Bug Fixes

package: update @octokit/request to version 3.0.0 (a09060d)

`v16.23.3`

Compare Source

Bug Fixes

2fa: avoid caching bad 2fa token (cd18520), closes #1309

`v16.23.2`

Compare Source

Bug Fixes

normalize pagination for responses with repository_selection property (27dff8c)

`v16.23.1`

Compare Source

Bug Fixes

package: atob-lite (d46f12a)

`v16.23.0`

Compare Source

Features

options.auth can be set to token without a prefix (736174e)

`v16.22.0`

Compare Source

Features

.teams.getByName() (#1300) (16a1a52)

`v16.21.1`

Compare Source

Bug Fixes

assure single object/array responses for .git.getRef()/.git.listRefs() (8ed1b9d)

`v16.21.0`

Compare Source

Features

author.*, committer.*, signature parameters for .git.createCommit() (dca2d51)
draft argument for creating a pull request (0e98b5b)

Bug Fixes

call auth.on2fa again if OTP becomes invalid (eb1ebab)

`v16.20.0`

Compare Source

Deprecation

deprecate .total_count, .incomplete_results and .<namespace> properties from paginated results (e34a1df)

Bug Fixes

normalize pagination results for all endpoints which paginate with a namespace (fff928d)
- https://developer.github.com/v3/search/#example (key items)
- https://developer.github.com/v3/checks/runs/#response-3 (key: check_runs)
- https://developer.github.com/v3/checks/suites/#response-1 (key: check_suites)
- https://developer.github.com/v3/apps/installations/#list-repositories (key: repositories)

`v16.19.0`

Compare Source

Features

octokit.repos.enablePagesSite() and octokit.repos.disablePagesSite() (a91f162), closes #1284

Bug Fixes

mister-fantastic preview not required for .repos.{getPages|updateInformationAboutPagesSite} (21f54ed)

`v16.18.1`

Compare Source

Bug Fixes

two-factor auth: persist one-time password header on subsequent requests (#1281) (db6af77)

`v16.18.0`

Compare Source

Features

media type format and previews (6ac0b9f)

octokit.issues.get({
  owner, 
  repo, 
  number,
  mediaType: {
    format: 'full+json',
    previews: ['symmetra']
  }
})

Bug Fixes

don’t swallow errors thrown in options.auth function (6660902)

`v16.17.1`

Compare Source

Bug Fixes

log a deprecations only once, and not as Error (547fe40)
set machine-man preview for .apps.listRepos() and .apps.getBySlug() (b2be62c)

`v16.17.0`

Compare Source

Features

octokit.licenses.listCommonlyUsed() (#1268) (ca3ac5b)

Deprecations

octokit.licenses.list()

`v16.16.5`

Compare Source

Bug Fixes

package: update @octokit/request to version 2.4.1 (578d8ab)

`v16.16.4`

Compare Source

Bug Fixes

package: update before-after-hook (aa54fb8)

`v16.16.3`

Compare Source

Bug Fixes

package: @octokit/request v2.4.0 (3cf7d47)
redact credentails from error.request (fc4f087)

`v16.16.2`

Compare Source

Bug Fixes

paginate search results (8373934)

`v16.16.1`

Compare Source

Bug Fixes

"affiliation" is not an enum parameter (#1257) (a8154c9)

`v16.16.0`

Compare Source

Features

.projects.createForAuthenticatedUser(), .projects.listForUser() (735d46f)

`v16.15.1`

Compare Source

Bug Fixes

don’t swallow errors thrown in options.auth function (1a91248)

`v16.15.0`

Compare Source

Bug Fixes

name parameter no longer required for octokit.repos.createHook() (6e53694)

Features

sort and direction parameters for octokit.repos.listForOrg() (2f9f5df)

`v16.14.1`

Compare Source

Bug Fixes

typescript: reference esnext.asynciterable (#1229) (101a246)

`v16.14.0`

Compare Source

Features

custom logging (#1205)

This release adds 4 new methods

octokit.log.debug()
octokit.log.info()
octokit.log.warn()
octokit.log.error()

They can be configured using the log client option. By default, octokit.log.debug() and octokit.log.info() are no-ops, while the other two call console.warn() and console.error() respectively.

This can be used for debugging. The simplest way is to set the log option to console

const octokit = require("@&#8203;octokit/rest")({
  log: console
})

console.request("/")

This will log

request { method: "GET",
  baseUrl: "https://api.github.com",
  headers:
   { accept: "application/vnd.github.v3+json",
     "user-agent":
      "octokit.js/0.0.0-semantically-released Node.js/10.15.0 (macOS Mojave; x64)" },
  request: {},
  url: "/" }
GET / - 200 in 514ms

If you like to support a configurable log level, we recommend using the console-log-level module

const octokit = require("@&#8203;octokit/rest")({
  log: require("console-log-level")({ level: "info" })
})

console.request("/")

This will only log

GET / - 200 in 514ms

`v16.13.4`

Compare Source

Bug Fixes

typescript: auth.client_id, auth.client_secret → auth.clientId, auth.clientSecret (#1227) (1ac39cd)

`v16.13.3`

Compare Source

Bug Fixes

typescript: accept { auth: () => } constructor option (0e11699)

`v16.13.2`

Compare Source

Bug Fixes

typescript: two-factor authentication is on2fa() not on2Fa() (#1222) (28a6f32)

`v16.13.1`

Compare Source

Bug Fixes

typescript: update typings with new options for constructor (2b73d01)

`v16.13.0`

Compare Source

Features

"auth" constructor options (45a4836)

`v16.12.0`

Compare Source

Features

userAgent, previews and request options (8cf0d4d)

In preparation for v17, instead of

const octokit = new Octokit({
  headers: {
    accept: 'application/vnd.github.jean-grey-preview+json,application/vnd.github.symmetra-preview+json',
    'user-agent': 'octokit/rest.js v1.2.3' // v1.2.3 will be current version
  },
  timeout: 0,
  agent: undefined
})

the new options will be

const octokit = new Octokit({
  userAgent: 'myapp v1.2.3',
  previews: [
    'jean-grey-preview',
    'symmetra-preview'
  ],
  request: {
    timeout: 0,
    agent: undefined
  }
})

The old options will continue to work, but will be deprecated. The baseUrl option will remain the same.

`v16.11.0`

Compare Source

Bug Fixes

handle invalid otp for 2FA (d29ec5a)

Features

Resolve requsets with response.url (9517b47)

`v16.10.0`

Compare Source

Features

two-factor authentication (fb38885)

`v16.9.0`

Compare Source

Features

octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() - octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() is now deprecated (fe4d9fb)
octokit.repos.updateReview({owner,repo,number,review_id,body}) (6527b32)
octokit.search.issuesAndPullRequests() - octokit.search.issues() is now deprecated (a8e392a)

Bug Fixes

octokit.projects.update() - invalid public parameter replaced with private (fecabe5)
octokit.search.repos() - sort parameter now accepts 'help-wanted-issues' (d528c50)

`v16.8.1`

Compare Source

Bug Fixes

do not load the same plugin again (b4c38e2)

`v16.8.0`

Compare Source

Features

typescript: octokit.registerEndpoints() definitions (724f8f6)
typescript: complete .endpoint types (c068824)

Bug Fixes

allow to use octokit.registerEndpoints() to merge new endpoints into existing scope (2c672ca)

`v16.7.0`

Compare Source

`v16.6.1`

Compare Source

[`v16.6.0`](https://github.com/octokit/rest.js/compare/v16.5.0...v16.6.

Renovate configuration

📅 Schedule: "after 10pm every weekday,before 5am every weekday,every weekend" (UTC).

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

♻️ Rebasing: Whenever PR is behind base branch, 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.

Signed-off-by: Renovate Bot <[email protected]>

fix(deps): update dependency @octokit/rest to v17

572dea0

Signed-off-by: Renovate Bot <[email protected]>

renovate bot added Bot: Renovate dependencies upgrade from renovate Priority: Low Low priority Status: In Review Need to review a issue/pull-request Type: Dependency For make any change with dependency labels Mar 14, 2020

renovate bot assigned kamontat Mar 14, 2020

renovate bot requested a review from kamontat March 14, 2020 12:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(deps): update dependency @octokit/rest to v17 #7

fix(deps): update dependency @octokit/rest to v17 #7

renovate bot commented Mar 14, 2020

fix(deps): update dependency @octokit/rest to v17 #7

Are you sure you want to change the base?

fix(deps): update dependency @octokit/rest to v17 #7

Conversation

renovate bot commented Mar 14, 2020

Release Notes

Features

Bug Fixes

Breaking Changes

Features

✨🦄

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

Features

Bug Fixes

Bug Fixes

Bug Fixes

Features

Features

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

Deprecations

Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Features

Features

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

Bug Fixes

Features

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Bug Fixes

Features

Features

Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

Features

Bug Fixes

Bug Fixes

Features

Bug Fixes

⚠️ This release has a bug, see #​1323

Bug Fixes

Bug Fixes

Bug Fixes

Bug Fixes

⚠️ This release has a bug, see #1323