Update dependency @octokit/rest to v18 (!11926) · Merge requests · Administrator / sourcegraph

Administrator requested to merge renovate/octokit-rest-18.x into main Jul 03, 2020

Created by: renovate[bot]

This PR contains the following updates:

Package	Type	Update	New value	References	Sourcegraph
@octokit/rest	devDependencies	major	^18.0.4	source

Release Notes

octokit/rest.js

`v18.0.4`

Compare Source

Bug Fixes

deps: bump @octokit/plugin-rest-endpoint-methods from 4.1.2 to 4.1.3 (README update only, no code changes) (0106e28)

Install the latest v17 version (17.11.2 as of this writing). Run your tests and address all deprecation messages. Once all deprecations have been addressed, the upgrade to v18 should be easy. The only changes are removals of previously deprecated APIs.

BREAKING CHANGES

Octokit.plugin() no longer accepts an array as first argument. Pass multiple arguments instead, e.g. Octokit.plugin(plugin1, plugin2)
deprecated octokit.reactions.deleteLegacy() has been removed
deprecated octokit.repos.getDownloads() has been removed
deprecated octokit.repos.listDownloads() has been removed
deprecated octokit.repos.deleteDownloads() has been removed
octokit.actions.createOrUpdateRepoSecret(): parameter name has been renamed to secret_name
octokit.actions.createOrUpdateSecretForRepo() has been renamed to octokit.actions.createOrUpdateRepoSecret()
octokit.actions.createOrUpdateRepoSecret(): parameter name has been renamed to secret_name
octokit.actions.createRegistrationToken() has been renamed to octokit.actions.createRegistrationTokenForRepo()
octokit.actions.createRemoveToken() has been renamed to octokit.actions.createRemoveTokenForRepo()
octokit.actions.deleteRepoSecret(): parameter name has been renamed to secret_name
octokit.actions.deleteSecretFromRepo() has been renamed to octokit.actions.deleteRepoSecret()
octokit.actions.deleteRepoSecret(): parameter name has been renamed to secret_name
octokit.actions.downloadWorkflowJobLogs() has been renamed to octokit.actions.downloadJobLogsForWorkflowRun()
octokit.actions.getPublicKey() has been renamed to octokit.actions.getRepoPublicKey()
octokit.actions.getRepoSecret(): parameter name has been renamed to secret_name
octokit.actions.getSecret() has been renamed to octokit.actions.getRepoSecret()
octokit.actions.getRepoSecret(): parameter name has been renamed to secret_name
octokit.actions.getSelfHostedRunner() has been renamed to octokit.actions.getSelfHostedRunnerForRepo()
octokit.actions.getWorkflowJob() has been renamed to octokit.actions.getJobForWorkflowRun()
octokit.actions.listDownloadsForSelfHostedRunnerApplication() has been renamed to octokit.actions.listRunnerApplicationsForRepo()
octokit.actions.listRepoWorkflowRuns() has been renamed to octokit.actions.listWorkflowRunsForRepo()
octokit.actions.listSecretsForRepo() has been renamed to octokit.actions.listRepoSecrets()
octokit.actions.listWorkflowJobLogs() has been renamed to octokit.actions.downloadWorkflowJobLogs()
octokit.actions.listWorkflowRunLogs() has been renamed to octokit.actions.downloadWorkflowRunLogs()
octokit.actions.removeSelfHostedRunner() has been renamed to octokit.actions.deleteSelfHostedRunnerFromRepo()
octokit.activity.checkStarringRepo() has been renamed to octokit.activity.checkRepoIsStarredByAuthenticatedUser()
octokit.activity.getThreadSubscription() has been renamed to octokit.activity.getThreadSubscriptionForAuthenticatedUser()
octokit.activity.listEventsForOrg() has been renamed to octokit.activity.listOrgEventsForAuthenticatedUser()
octokit.activity.listEventsForUser() has been renamed to octokit.activity.listEventsForAuthenticatedUser()
octokit.activity.listFeeds() has been renamed to octokit.activity.getFeeds()
octokit.activity.listNotifications() has been renamed to octokit.activity.listNotificationsForAuthenticatedUser()
octokit.activity.listNotificationsForRepo() has been renamed to octokit.activity.listRepoNotificationsForAuthenticatedUser()
octokit.activity.listPublicEventsForOrg() has been renamed to octokit.activity.listPublicOrgEvents()
octokit.activity.markAsRead() has been renamed to octokit.activity.markNotificationsAsRead()
octokit.activity.markNotificationsAsReadForRepo() has been renamed to octokit.activity.markRepoNotificationsAsRead()
octokit.activity.starRepo() has been renamed to octokit.activity.starRepoForAuthenticatedUser()
octokit.activity.unstarRepo() has been renamed to octokit.activity.unstarRepoForAuthenticatedUser()
octokit.apps.checkAccountIsAssociatedWithAny() has been renamed to octokit.apps.getSubscriptionPlanForAccount()
octokit.apps.checkAccountIsAssociatedWithAnyStubbed() has been renamed to octokit.apps.getSubscriptionPlanForAccountStubbed()
octokit.apps.createInstallationToken() has been renamed to octokit.apps.createInstallationAccessToken()
octokit.apps.listAccountsUserOrOrgOnPlan() has been renamed to octokit.apps.listAccountsForPlan()
octokit.apps.listAccountsUserOrOrgOnPlanStubbed() has been renamed to octokit.apps.listAccountsForPlanStubbed()
octokit.apps.listMarketplacePurchasesForAuthenticatedUser() has been renamed to octokit.apps.listSubscriptionsForAuthenticatedUser()
octokit.apps.listMarketplacePurchasesForAuthenticatedUserStubbed() has been renamed to octokit.apps.listSubscriptionsForAuthenticatedUserStubbed()
octokit.apps.listRepos() has been renamed to octokit.apps.listReposAccessibleToInstallation()
octokit.apps.revokeInstallationToken() has been renamed to octokit.apps.revokeInstallationAccessToken()
octokit.codesOfConduct.listConductCodes() has been renamed to octokit.codesOfConduct.getAllCodesOfConduct()
octokit.gists.listPublicForUser() has been renamed to octokit.gists.listForUser()
octokit.gitignore.listTemplates() has been renamed to octokit.gitignore.getAllTemplates()
octokit.interactions.addOrUpdateRestrictionsForOrg() has been renamed to octokit.interactions.setRestrictionsForOrg()
octokit.interactions.addOrUpdateRestrictionsForRepo() has been renamed to octokit.interactions.setRestrictionsForRepo()
octokit.issues.checkAssignee() has been renamed to octokit.issues.checkUserCanBeAssigned()
octokit.issues.listMilestonesForRepo() has been renamed to octokit.issues.listMilestones()
octokit.issues.removeLabels() has been renamed to octokit.issues.removeAllLabels()
octokit.issues.replaceAllLabels() has been renamed to octokit.issues.setLabels()
octokit.issues.replaceLabels() has been renamed to octokit.issues.replaceAllLabels()
octokit.licenses.listCommonlyUsed() has been renamed to octokit.licenses.getAllCommonlyUsed()
octokit.migrations.getImportProgress() has been renamed to octokit.migrations.getImportStatus()
octokit.orgs.addOrUpdateMembership() has been renamed to octokit.orgs.setMembershipForUser()
octokit.orgs.checkMembership() has been renamed to octokit.orgs.checkMembershipForUser()
octokit.orgs.checkPublicMembership() has been renamed to octokit.orgs.checkPublicMembershipForUser()
octokit.orgs.concealMembership() has been renamed to octokit.orgs.removePublicMembershipForAuthenticatedUser()
octokit.orgs.createHook() has been renamed to octokit.orgs.createWebhook()
octokit.orgs.deleteHook() has been renamed to octokit.orgs.deleteWebhook()
octokit.orgs.getHook() has been renamed to octokit.orgs.getWebhook()
octokit.orgs.getMembership() has been renamed to octokit.orgs.getMembershipForUser()
octokit.orgs.listHooks() has been renamed to octokit.orgs.listWebhooks()
octokit.orgs.listInstallations() has been renamed to octokit.orgs.listAppInstallations()
octokit.orgs.listMemberships() has been renamed to octokit.orgs.listMembershipsForAuthenticatedUser()
octokit.orgs.pingHook() has been renamed to octokit.orgs.pingWebhook()
octokit.orgs.publicizeMembership() has been renamed to octokit.orgs.setPublicMembershipForAuthenticatedUser()
octokit.orgs.removeMembership() has been renamed to octokit.orgs.removeMembershipForUser()
octokit.orgs.updateHook() has been renamed to octokit.orgs.updateWebhook()
octokit.orgs.updateMembership() has been renamed to octokit.orgs.updateMembershipForAuthenticatedUser()
octokit.projects.reviewUserPermissionLevel() has been renamed to octokit.projects.getPermissionForUser()
octokit.pulls.createComment() has been renamed to octokit.pulls.createReviewComment()
octokit.pulls.createReviewCommentReply() has been renamed to octokit.pulls.createReplyForReviewComment()
octokit.pulls.createReviewRequest() has been renamed to octokit.pulls.requestReviewers()
octokit.pulls.deleteComment() has been renamed to octokit.pulls.deleteReviewComment()
octokit.pulls.deleteReviewRequest() has been renamed to octokit.pulls.removeRequestedReviewers()
octokit.pulls.getComment() has been renamed to octokit.pulls.getReviewComment()
octokit.pulls.getCommentsForReview() has been renamed to octokit.pulls.listCommentsForReview()
octokit.pulls.listComments() has been renamed to octokit.pulls.listReviewComments()
octokit.pulls.listCommentsForRepo() has been renamed to octokit.pulls.listReviewCommentsForRepo()
octokit.pulls.listReviewRequests() has been renamed to octokit.pulls.listRequestedReviewers()
octokit.pulls.updateComment() has been renamed to octokit.pulls.updateReviewComment()
octokit.reactions.delete() has been renamed to octokit.reactions.deleteLegacy()
octokit.repos.addDeployKey() has been renamed to octokit.repos.createDeployKey()
octokit.repos.addProtectedBranchAdminEnforcement() has been renamed to octokit.repos.setAdminBranchProtection()
octokit.repos.addProtectedBranchAppRestrictions() has been renamed to octokit.repos.addAppAccessRestrictions()
octokit.repos.addProtectedBranchRequiredSignatures() has been renamed to octokit.repos.createCommitSignatureProtection()
octokit.repos.addProtectedBranchRequiredStatusChecksContexts() has been renamed to octokit.repos.addStatusCheckContexts()
octokit.repos.addProtectedBranchTeamRestrictions() has been renamed to octokit.repos.addTeamAccessRestrictions()
octokit.repos.addProtectedBranchUserRestrictions() has been renamed to octokit.repos.addUserAccessRestrictions()
octokit.repos.createHook() has been renamed to octokit.repos.createWebhook()
octokit.repos.createOrUpdateFile() has been renamed to octokit.repos.createOrUpdateFileContents()
octokit.repos.createStatus() has been renamed to octokit.repos.createCommitStatus()
octokit.repos.deleteHook() has been renamed to octokit.repos.deleteWebhook()
octokit.repos.disablePagesSite() has been renamed to octokit.repos.deletePagesSite()
octokit.repos.enablePagesSite() has been renamed to octokit.repos.createPagesSite()
octokit.repos.getArchiveLink() has been renamed to octokit.repos.downloadArchive()
octokit.repos.getContents() has been renamed to octokit.repos.getContent()
octokit.repos.getHook() has been renamed to octokit.repos.getWebhook()
octokit.repos.getProtectedBranchAdminEnforcement() has been renamed to octokit.repos.getAdminBranchProtection()
octokit.repos.getProtectedBranchPullRequestReviewEnforcement() has been renamed to octokit.repos.getPullRequestReviewProtection()
octokit.repos.getProtectedBranchRequiredSignatures() has been renamed to octokit.repos.getCommitSignatureProtection()
octokit.repos.getProtectedBranchRequiredStatusChecks() has been renamed to octokit.repos.getStatusChecksProtection()
octokit.repos.getProtectedBranchRestrictions() has been renamed to octokit.repos.getAccessRestrictions()
octokit.repos.list() has been renamed to octokit.repos.listForAuthenticatedUser()
octokit.repos.listAssetsForRelease() has been renamed to octokit.repos.listReleaseAssets()
octokit.repos.listCommitComments() has been renamed to octokit.repos.listCommitCommentsForRepo()
octokit.repos.listHooks() has been renamed to octokit.repos.listWebhooks()
octokit.repos.listProtectedBranchRequiredStatusChecksContexts() has been renamed to octokit.repos.getAllStatusCheckContexts()
octokit.repos.listStatusesForRef() has been renamed to octokit.repos.listCommitStatusesForRef()
octokit.repos.listTopics() has been renamed to octokit.repos.getAllTopics()
octokit.repos.pingHook() has been renamed to octokit.repos.pingWebhook()
octokit.repos.removeBranchProtection() has been renamed to octokit.repos.deleteBranchProtection()
octokit.repos.removeDeployKey() has been renamed to octokit.repos.deleteDeployKey()
octokit.repos.removeProtectedBranchAdminEnforcement() has been renamed to octokit.repos.deleteAdminBranchProtection()
octokit.repos.removeProtectedBranchAppRestrictions() has been renamed to octokit.repos.removeAppAccessRestrictions()
octokit.repos.removeProtectedBranchPullRequestReviewEnforcement() has been renamed to octokit.repos.deletePullRequestReviewProtection()
octokit.repos.removeProtectedBranchRequiredSignatures() has been renamed to octokit.repos.deleteCommitSignatureProtection()
octokit.repos.removeProtectedBranchRequiredStatusChecks() has been renamed to octokit.repos.removeStatusChecksProtection()
octokit.repos.removeProtectedBranchRequiredStatusChecksContexts() has been renamed to octokit.repos.removeStatusCheckContexts()
octokit.repos.removeProtectedBranchRestrictions() has been renamed to octokit.repos.deleteAccessRestrictions()
octokit.repos.removeProtectedBranchTeamRestrictions() has been renamed to octokit.repos.removeTeamAccessRestrictions()
octokit.repos.removeProtectedBranchUserRestrictions() has been renamed to octokit.repos.removeUserAccessRestrictions()
octokit.repos.replaceProtectedBranchAppRestrictions() has been renamed to octokit.repos.setAppAccessRestrictions()
octokit.repos.replaceProtectedBranchRequiredStatusChecksContexts() has been renamed to octokit.repos.setStatusCheckContexts()
octokit.repos.replaceProtectedBranchTeamRestrictions() has been renamed to octokit.repos.setTeamAccessRestrictions()
octokit.repos.replaceProtectedBranchUserRestrictions() has been renamed to octokit.repos.setUserAccessRestrictions()
octokit.repos.replaceTopics() has been renamed to octokit.repos.replaceAllTopics()
octokit.repos.requestPageBuild() has been renamed to octokit.repos.requestPagesBuild()
octokit.repos.retrieveCommunityProfileMetrics() has been renamed to octokit.repos.getCommunityProfileMetrics()
octokit.repos.testPushHook() has been renamed to octokit.repos.testPushWebhook()
octokit.repos.updateHook() has been renamed to octokit.repos.updateWebhook()
octokit.repos.updateProtectedBranchPullRequestReviewEnforcement() has been renamed to octokit.repos.updatePullRequestReviewProtection()
octokit.repos.updateProtectedBranchRequiredStatusChecks() has been renamed to octokit.repos.updateStatusChecksProtection()
octokit.teams.addOrUpdateMembershipInOrg() has been renamed to octokit.teams.addOrUpdateMembershipForUserInOrg()
octokit.teams.addOrUpdateProjectInOrg() has been renamed to octokit.teams.addOrUpdateProjectPermissionsInOrg()
octokit.teams.addOrUpdateRepoInOrg() has been renamed to octokit.teams.addOrUpdateRepoPermissionsInOrg()
octokit.teams.checkManagesRepoInOrg() has been renamed to octokit.teams.checkPermissionsForRepoInOrg()
octokit.teams.getMembershipInOrg() has been renamed to octokit.teams.getMembershipForUserInOrg()
octokit.teams.removeMembershipInOrg() has been renamed to octokit.teams.removeMembershipForUserInOrg()
octokit.teams.reviewProjectInOrg() has been renamed to octokit.teams.checkPermissionsForProjectInOrg()
octokit.users.addEmails() has been renamed to octokit.users.addEmailsForAuthenticated()
octokit.users.checkFollowing() has been renamed to octokit.users.checkPersonIsFollowedByAuthenticated()
octokit.users.createGpgKey() has been renamed to octokit.users.createGpgKeyForAuthenticated()
octokit.users.createPublicKey() has been renamed to octokit.users.createPublicSshKeyForAuthenticated()
octokit.users.deleteEmails() has been renamed to octokit.users.deleteEmailsForAuthenticated()
octokit.users.deleteGpgKey() has been renamed to octokit.users.deleteGpgKeyForAuthenticated()
octokit.users.deletePublicKey() has been renamed to octokit.users.deletePublicSshKeyForAuthenticated()
octokit.users.getGpgKey() has been renamed to octokit.users.getGpgKeyForAuthenticated()
octokit.users.getPublicKey() has been renamed to octokit.users.getPublicSshKeyForAuthenticated()
octokit.users.listBlocked() has been renamed to octokit.users.listBlockedByAuthenticated()
octokit.users.listEmails() has been renamed to octokit.users.listEmailsForAuthenticated()
octokit.users.listFollowingForAuthenticatedUser() has been renamed to octokit.users.listFollowedByAuthenticated()
octokit.users.listGpgKeys() has been renamed to octokit.users.listGpgKeysForAuthenticated()
octokit.users.listPublicEmails() has been renamed to octokit.users.listPublicEmailsForAuthenticatedUser()
octokit.users.listPublicKeys() has been renamed to octokit.users.listPublicSshKeysForAuthenticated()
octokit.users.togglePrimaryEmailVisibility() has been renamed to octokit.users.setPrimaryEmailVisibilityForAuthenticated()

`v17.11.2`

Compare Source

Bug Fixes

reverts changes in faulty 17.11.1 release

`v17.11.1`

Compare Source

faulty release, please ignore

`v17.11.0`

Compare Source

Features

repos.getAccessRestrictions
pulls.listCommentsForReview
pulls.removeRequestedReviewers
pulls.requestReviewers
pulls.listRequestedReviewers
pulls.createReplyForReviewComment
pulls.createReviewComment
pulls.listReviewComments
pulls.deleteReviewComment
pulls.updateReviewComment
pulls.getReviewComment
pulls.listReviewCommentsForRepo
projects.getPermissionForUser
orgs.listPublicEmailsForAuthenticatedUser
orgs.updateMembershipForAuthenticatedUser
orgs.listMembershipsForAuthenticatedUser
users.deletePublicSshKeyForAuthenticated
users.getPublicSshKeyForAuthenticated
users.createPublicSshKeyForAuthenticated
users.listPublicSshKeysForAuthenticated
users.deleteGpgKeyForAuthenticated
users.getGpgKeyForAuthenticated
users.createGpgKeyForAuthenticated
users.listGpgKeysForAuthenticated
users.checkPersonIsFollowedByAuthenticated
users.deleteEmailsForAuthenticated
users.addEmailsForAuthenticated
users.listEmailsForAuthenticated
users.setPrimaryEmailVisibilityForAuthenticated
users.listBlockedByAuthenticated
scim.deleteUserFromOrg
scim.updateAttributeForUser
scim.setInformationForProvisionedUser
scim.getProvisioningInformationForUser
scim.provisionAndInviteUser
repos.downloadArchive
repos.createCommitStatus
repos.listReleaseAssets
repos.requestPagesBuild
repos.deletePagesSite
repos.createPagesSite
repos.deleteDeployKey
repos.createDeployKey
testPushWebhook
pingWebhook
deleteWebhook
updateWebhook
getWebhook
createWebhook
listWebhooks
repos.createOrUpdateFileContents
repos.getContent
repos.getCommunityProfileMetrics
repos.listCommitStatusesForRef
repos.listCommitComments
repos.removeUserAccessRestrictions
repos.addUserAccessRestrictions
repos.setUserAccessRestrictions
repos.removeTeamAccessRestrictions
repos.addTeamAccessRestrictions
repos.setTeamAccessRestrictions
repos.removeAppAccessRestrictions
repos.addAppAccessRestrictions
repos.setAppAccessRestrictions
repos.removeProtectedBranchRestrictions
repos.removeStatusCheckContexts
repos.addStatusCheckContexts
repos.setStatusCheckContexts
repos.getAllStatusCheckContexts
repos.removeStatusChecksProtection
repos.updateStatusChecksProtection
repos.getStatusChecksProtection
repos.deleteCommitSignatureProtection
repos.createCommitSignatureProtection
repos.getCommitSignatureProtection
repos.deletePullRequestReviewProtection
repos.updatePullRequestReviewProtection
repos.getPullRequestReviewProtection
repos.deleteAdminBranchProtection
repos.setAdminBranchProtection
repos.getAdminBranchProtection
repos.deleteBranchProtection
orgs.removePublicMembershipForAuthenticatedUser
orgs.setPublicMembershipForAuthenticatedUser
orgs.checkPublicMembershipForUser
orgs.removeMembershipForUser
orgs.setMembershipForUser
orgs.getMembershipForUser
orgs.checkMembershipForUser
orgs.listAppInstallations
orgs.pingHook
orgs.deleteHook
orgs.updateHook
orgs.getHook
orgs.createHook
orgs.listHooks
orgs.removeCredentialAuthorization
orgs.listSamlSsoAuthorizations
repos.listCommitCommentsForRepo
gitignore.getAllTemplates
licenses.getAllCommonlyUsed

Deprecations

repos.getProtectedBranchRestrictions
pulls.getCommentsForReview
pulls.deleteReviewRequest
pulls.createReviewRequest
pulls.listReviewRequests
pulls.createReviewCommentReply
pulls.createComment
pulls.listComments
pulls.deleteComment
pulls.updateComment
pulls.getComment
pulls.listCommentsForRepo
projects.reviewUserPermissionLevel
orgs.listPublicEmails
orgs.updateMembership
orgs.listMemberships
users.deletePublicKey
users.getPublicKey
users.createPublicKey
users.listPublicKeys
users.deleteGpgKey
users.getGpgKey
users.createGpgKey
users.listGpgKeys
users.checkFollowing
users.deleteEmailsForAuthenticated
users.addEmailsForAuthenticated
users.listEmailsForAuthenticated
users.togglePrimaryEmailVisibility
users.listBlocked
scim.removeUserFromOrg
scim.updateUserAttribute
scim.replaceProvisionedUserInformation
scim.getProvisioningDetailsForUser
scim.provisionAndInviteUsers
repos.getArchiveLink
repos.createStatus
repos.listAssetsForRelease
repos.requestPageBuild
repos.disbalePagesSite
repos.enablePagesSite
repos.removeDeployKey
repos.addDeployKey
testPushHook
pingHook
deleteHook
updateHook
getHook
createHook
listHooks
repos.createOrUpdateFile
repos.getContents
repos.retrieveCommunityProfileMetrics
repos.listStatusesForRef
repos.listCommentsForCommit
repos.removeProtectedBranchUserRestrictions
repos.addProtectedBranchUserRestrictions
repos.replaceProtectedBranchUserRestrictions
repos.removeProtectedBranchTeamRestrictions
repos.addProtectedBranchTeamRestrictions
repos.replaceProtectedBranchTeamRestrictions
repos.removeProtectedBranchAppRestrictions
repos.addProtectedBranchAppRestrictions
repos.replaceProtectedBranchAppRestrictions
repos.deleteAccessRestrictions
repos.removeProtectedBranchRequiredStatusChecksContexts
repos.addProtectedBranchRequiredStatusChecksContexts
repos.replaceProtectedBranchRequiredStatusChecksContexts
repos.listProtectedBranchRequiredStatusChecksContexts
repos.removeProtectedBranchRequiredStatusChecks
repos.updateProtectedBranchRequiredStatusChecks
repos.getProtectedBranchRequiredStatusChecks
repos.removeProtectedBranchRequiredSignatures
repos.addProtectedBranchRequiredSignatures
repos.getProtectedBranchRequiredSignatures
repos.removeProtectedBranchPullRequestReviewEnforcement
repos.updateProtectedBranchPullRequestReviewEnforcement
repos.getProtectedBranchPullRequestReviewEnforcement
repos.removeProtectedBranchAdminEnforcement
repos.addProtectedBranchAdminEnforcement
repos.getProtectedBranchAdminEnforcement
repos.removeBranchProtection
orgs.concealMembership
orgs.publicizeMembership
orgs.checkPublicMembership
orgs.removeMembership
orgs.addOrUpdateMembership
orgs.getMembership
orgs.checkMembership
orgs.listInstallations
orgs.pingWebhook
orgs.deleteWebhook
orgs.updateWebhook
orgs.getWebhook
orgs.createWebhook
orgs.listWebhooks
orgs.removeSamlSsoAuthorization
orgs.listCredentialAuthorizations
repos.listCommitComments.
gitignore.listTemplates
licenses.listCommonlyUsed

`v17.10.0`

Compare Source

Features

actions.downloadJobLogsForWorkflowRun, actions.getJobForWorkflowRun, actions.listWorkflowRunsForRepo, actions.createInstallationAccessToken, apps.listReposAccessibleToInstallation, apps.revokeInstallationAccessToken, interactions.setRestrictionsForOrg, interactions.setRestrictionsForRepo. Deprecates actions.downloadWorkflowJobLogs, actions.getWorkflowJob, actions.listRepoWorkflowRuns, actions.createInstallationToken, apps.listRepos, apps.revokeInstallationToken, interactions.addOrUpdateRestrictionsForOrg, interactions.addOrUpdateRestrictionsForRepo, issues.replaceAllLabels (#1750) (e0b4282)

`v17.9.3`

Compare Source

Bug Fixes

deps: bump @octokit/plugin-rest-endpoint-methods from 3.13.3 to 3.14.0 (ca7e89f)

`v17.9.2`

Compare Source

Bug Fixes

handle deprecated parameters (#1716) (c9cfbb4)

`v17.9.1`

Compare Source

Bug Fixes

TypeScript: `octokit.gists.{create,update}({ gist_id, files }) (#1714) (647e3a6)

`v17.9.0`

Compare Source

Features

typescript: optional ref parameter for .codeScanning.listAlertsForRepo() method (#1706) (b61c123)

`v17.8.0`

Compare Source

Features

octokit.codeScanning.{getAlert,listAlertsForRepo} (#1701) (f94ccea)

`v17.7.0`

Compare Source

Features

octokit.actions.downloadWorkflow{Job,Run}logs, octokit.apps.{suspend,unsuspend}Installation. Deprecates octokit.actions.listWorkflow{Job,Run}Logs (#1700) (f591f34)

`v17.6.0`

Compare Source

Features

typescript: set types for parameters and results/responses automagically (#1690) (80e87a0)

`v17.5.2`

Compare Source

Bug Fixes

typescript: remove obsolete ?{page,per_page} parameters (#1685) (a4c536d)

`v17.5.1`

Compare Source

Bug Fixes

typescript: define .defaults() method on rest endpoint method types (#1681) (4f23359)

`v17.5.0`

Compare Source

Features

typescript: import { RestEndpointMethodTypes } from "@octokit/rest"; (#1680) (6a9f9a4)

`v17.4.0`

Compare Source

Features

octokit.actions.deleteWorkflowRunLogs() (#1673) (0386dad)

`v17.3.0`

Compare Source

Features

simpler pagination using endpoint methods as first argument (#1672) (548d65a)

Before

const options = octokit.issues.listForRepo.endpoint.merge({
  owner: "octokit",
  repo: "rest.js",
});
const issues = await octokit.paginate(options);

After

const issues = await octokit.paginate(octokit.issues.listForRepo, {
  owner: "octokit",
  repo: "rest.js",
});

`v17.2.1`

Compare Source

Bug Fixes

TypeScript: method description updates (#1671) (3fba786)

`v17.2.0`

Compare Source

Features

maintain and triage user permissions in orgs, gambit preview graduated (#32) (#1665) (76f7fbe)

`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!')
}

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

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
URL parameters such as options.base and options.head for octokit.repos.compareCommits are now URL encoded automatically, you don't need to use encodeURIComponent() before passing the values to the endpoint methods.
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
})
```

TypeScript

In v16, many types have been exported on the exported Octokit Constructor. Although they were never documented, types such as Octokit.ChecksCreateParams have been used when wrapping Octokit's code in custom logic.

Starting with v17.5.0, parameter and response times are being officially exported. For example:

import { RestEndpointMethodTypes } from "@&#8203;octokit/rest";

// for `octokit.checks.create()`
RestEndpointMethodTypes["checks"]["create"]["parameters"]
RestEndpointMethodTypes["checks"]["create"]["response"]

✨🦄

48,624 lines of code down to 10. As in 10. Not 10,000. 10. Learn more about that on GitHub's blog: From 48k lines of code to 10—the story of GitHub’s JavaScript SDK

`v16.43.2`

Compare Source

Bug Fixes

typescript: return type for octokit.hook.wrap callback (#1770) (0798dcd)

`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)

`v16.41.2`

Compare Source

Bug Fixes

package: update @octokit/plugin-rest-endpoint-methods to version 2.3.0 (a10ef70), closes #1571

`v16.41.1`

Compare Source

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)