NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
npm · #2239 most downloaded on npm
GitHub REST API client for Node.js
Last release 10 months ago
31 Oct 2025
Release timing varies
gaps range from 2 weeks to 5 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
9 years old
302 releases · first in 2018
deps: update dependency @octokit/plugin-rest-endpoint-methods to v5.3.1
(that should have been a feature release, sorry)
(that should have been a feature release, sorry)
octokit.rest.repos.getPagesHealthCheck()codeScanning.listAlertInstances(), actions.approveWorkflowRun()apps.createContentAttachmentForRepo(), reactions.createForRelease(), repos.compareCommitsWithBasehead()codeScanning.listAlertsInstances()POST /repos/{owner}/{repo}/deployments (repos/create-deployment) does not accept a created_at parameterOne column per quarter.
remove legacy org and organization parameters from octokit.repos.createFork() again
deps: update dependency @octokit/plugin-rest-endpoint-methods to v5
## 18.5.1 (2021-03-26) ### Bug Fixes * README: link to documentation
The methods are also set on octokit.* for foreseeable time, but no longer documented, and will be deprecated at some point in future
octokit.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser() (deprecates octokit.packages.getAllPackageVersionsForAPackageOwnedByTheAuth…
octokit.repos.getReadmeInDirectory()octokit.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser() (deprecates octokit.packages.getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser())octokit.packages.getAllPackageVersionsForPackageOwnedByOrg() (deprecates octokit.packages.getAllPackageVersionsForAPackageOwnedByAnOrg)deps: update dependency @octokit/plugin-rest-endpoint-methods to v4.13.5
deps: update dependency @octokit/plugin-rest-endpoint-methods to v4.13.4
deps: update dependency @octokit/plugin-rest-endpoint-methods to v4.13.3
typescript: parameter types fixes for octokit.checks.create(), octokit.checks.update(), and octokit.gists.update()
deps: update dependency @octokit/plugin-rest-endpoint-methods to v4.13.1 (#2026) (7bd3575), closes #2028
octokit.actions.createOrUpdateEnvironmentSecret(), octokit.actions.deleteEnvironmentSecret(), octokit.actions.getEnvironmentPublicKey(), octokit.actio
octokit.actions.createOrUpdateEnvironmentSecret(), octokit.actions.deleteEnvironmentSecret(), octokit.actions.getEnvironmentPublicKey(), octokit.actions.getEnvironmentSecret(), octokit.actions.getPendingDeploymentsForRun(), octokit.actions.getReviewsForRun(), octokit.actions.listEnvironmentSecrets(), octokit.actions.reviewPendingDeploymentsForRun(), octokit.repos.createAnEnvironment(), octokit.repos.deleteAnEnvironment(), octokit.repos.getAllEnvironments(), octokit.repos.getEnvironment(), octokit.repos.setEnvironmentProtectionRules() (c36bb43)typescript: octokit.repos.createFork() has a never resolve type - via @octokit/plugin-rest-endpoint-methods v4.12.2
octokit.packages.deletePackageForAuthenticatedUser()
octokit.packages.deletePackageForAuthenticatedUser()octokit.packages.deletePackageForOrg()octokit.packages.deletePackageVersionForAuthenticatedUser()octokit.packages.deletePackageVersionForOrg()octokit.packages.getAllPackageVersionsForAPackageOwnedByAnOrg()octokit.packages.getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser()octokit.packages.getAllPackageVersionsForPackageOwnedByUser()octokit.packages.getPackageForAuthenticatedUser()octokit.packages.getPackageForOrganization()octokit.packages.getPackageForUser()octokit.packages.getPackageVersionForAuthenticatedUser()octokit.packages.getPackageVersionForOrganization()octokit.packages.getPackageVersionForUser()octokit.packages.restorePackageForAuthenticatedUser()octokit.packages.restorePackageForOrg()octokit.packages.restorePackageVersionForAuthenticatedUser()octokit.packages.restorePackageVersionForOrg()typescript: improved endpoint parameters and response types via @octokit/plugin-rest-endpoint-methods@4.10.3 / @octokit/types@6.8.4 / @octokit/openapi
octokit.interactions.{get,set,remove}RestrictionsForAuthenticatedUser(). Deprecates octokit.interactions.{get,set,remove}RestrictionsForYourPublicRepo…
## 18.0.15 (2021-01-25) ### Bug Fixes * deps: lock file maintenance
deps: update dependency @octokit/plugin-rest-endpoint-methods to v4.8.0
deps: update dependency @octokit/plugin-rest-endpoint-methods to v4.7.0
octokit.secretScanning.{getAlert,listAlertsForRepo,updateAlert} via `@octokit/plugin-rest-endpoint-methods`
octokit.secretScanning.{getAlert,listAlertsForRepo,updateAlert} via @octokit/plugin-rest-endpoint-methodsadapt for latest @octokit/types
…octokit.repos.updateStatusCheckProtection. Deprecates octokit.repos.downloadArchive, octokit.repos.updateStatusCheckPotection
actions.{disableSelectedRepositoryGithubActionsOrganization,disableWorkflow,enableSelectedRepositoryGithubActionsOrganization,enableWorkflow,getAllowedActionsOrganization,getAllowedActionsRepository,getGithubActionsPermissionsOrganization,listSelectedRepositoriesEnabledGithubActionsOrganization,setAllowedActionsOrganization,setAllowedActionsRepository,setGithubActionsPermissionsOrganization,setGithubActionsPermissionsRepository,setSelectedRepositoriesEnabledGithubActionsOrganization}, apps.{getWebhookConfigForApp,updateWebhookConfigForApp}, enterpriseAdmin.*, orgs.{getWebhookConfigForOrg,updateWebhookConfigForOrg}, repos.{getWebhookConfigForRepo,updateWebhookConfigForRepo} (3228865)octokit.actions.getRepoPermissions, octokit.meta.getOctocat, octokit.meta.getZen, octokit.meta.root, octokit.repos.downloadTarballArchive, octokit.repos.downloadZipballArchive, octokit.repos.updateStatusCheckProtection. Deprecates octokit.repos.downloadArchive, octokit.repos.updateStatusCheckPotection (c5c1d6e)octokit.interactions.{getRestrictionsForYourPublicRepos,removeRestrictionsForYourPublicRepos,setRestrictionsForYourPublicRepos} (e7988d9)deps: bump @octokit/plugin-rest-endpoint-methods from 4.2.0 to 4.2.1
docs: Remove broken client-options link
alert_id parameter has been deprecated. Use alert_number instead
octokit.codeScanning.listRecentAnalyses()octokit.codeScanning.updateAlert()octokit.codeScanning.uploadSarif()alert_id parameter has been deprecated. Use alert_number insteadmachine-man preview graduated (octokit/plugin-rest-endpoint-methods.js#185)
machine-man preview graduated (octokit/plugin-rest-endpoint-methods.js#185) (34559d8)deps: bump @octokit/plugin-rest-endpoint-methods from 4.1.2 to 4.1.3 (README update only, no code changes)
deps: bump @octokit/plugin-rest-endpoint-methods from 4.1.1 to 4.1.2
deps: bump @octokit/plugin-rest-endpoint-methods from 4.1.0 to 4.1.1
deps: bump @octokit/plugin-rest-endpoint-methods from 4.0.0 to 4.1.0
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 addr…
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.
Octokit.plugin() no longer accepts an array as first argument. Pass multiple arguments instead, e.g. Octokit.plugin(plugin1, plugin2)octokit.reactions.deleteLegacy() has been removedoctokit.repos.getDownloads() has been removedoctokit.repos.listDownloads() has been removedoctokit.repos.deleteDownloads() has been removedoctokit.actions.createOrUpdateRepoSecret(): parameter name has been renamed to secret_nameoctokit.actions.createOrUpdateSecretForRepo() has been renamed to octokit.actions.createOrUpdateRepoSecret()octokit.actions.createOrUpdateRepoSecret(): parameter name has been renamed to secret_nameoctokit.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_nameoctokit.actions.deleteSecretFromRepo() has been renamed to octokit.actions.deleteRepoSecret()octokit.actions.deleteRepoSecret(): parameter name has been renamed to secret_nameoctokit.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_nameoctokit.actions.getSecret() has been renamed to octokit.actions.getRepoSecret()octokit.actions.getRepoSecret(): parameter name has been renamed to secret_nameoctokit.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()reverts changes in faulty 17.11.1 release
Nothing published for this version
pulls.createReplyForReviewComment
repos.getAccessRestrictionspulls.listCommentsForReviewpulls.removeRequestedReviewerspulls.requestReviewerspulls.listRequestedReviewerspulls.createReplyForReviewCommentpulls.createReviewCommentpulls.listReviewCommentspulls.deleteReviewCommentpulls.updateReviewCommentpulls.getReviewCommentpulls.listReviewCommentsForRepoprojects.getPermissionForUserorgs.listPublicEmailsForAuthenticatedUserorgs.updateMembershipForAuthenticatedUserorgs.listMembershipsForAuthenticatedUserusers.deletePublicSshKeyForAuthenticatedusers.getPublicSshKeyForAuthenticatedusers.createPublicSshKeyForAuthenticatedusers.listPublicSshKeysForAuthenticatedusers.deleteGpgKeyForAuthenticatedusers.getGpgKeyForAuthenticatedusers.createGpgKeyForAuthenticatedusers.listGpgKeysForAuthenticatedusers.checkPersonIsFollowedByAuthenticatedusers.deleteEmailsForAuthenticatedusers.addEmailsForAuthenticatedusers.listEmailsForAuthenticatedusers.setPrimaryEmailVisibilityForAuthenticatedusers.listBlockedByAuthenticatedscim.deleteUserFromOrgscim.updateAttributeForUserscim.setInformationForProvisionedUserscim.getProvisioningInformationForUserscim.provisionAndInviteUserrepos.downloadArchiverepos.createCommitStatusrepos.listReleaseAssetsrepos.requestPagesBuildrepos.deletePagesSiterepos.createPagesSiterepos.deleteDeployKeyrepos.createDeployKeytestPushWebhookpingWebhookdeleteWebhookupdateWebhookgetWebhookcreateWebhooklistWebhooksrepos.createOrUpdateFileContentsrepos.getContentrepos.getCommunityProfileMetricsrepos.listCommitStatusesForRefrepos.listCommitCommentsrepos.removeUserAccessRestrictionsrepos.addUserAccessRestrictionsrepos.setUserAccessRestrictionsrepos.removeTeamAccessRestrictionsrepos.addTeamAccessRestrictionsrepos.setTeamAccessRestrictionsrepos.removeAppAccessRestrictionsrepos.addAppAccessRestrictionsrepos.setAppAccessRestrictionsrepos.removeProtectedBranchRestrictionsrepos.removeStatusCheckContextsrepos.addStatusCheckContextsrepos.setStatusCheckContextsrepos.getAllStatusCheckContextsrepos.removeStatusChecksProtectionrepos.updateStatusChecksProtectionrepos.getStatusChecksProtectionrepos.deleteCommitSignatureProtectionrepos.createCommitSignatureProtectionrepos.getCommitSignatureProtectionrepos.deletePullRequestReviewProtectionrepos.updatePullRequestReviewProtectionrepos.getPullRequestReviewProtectionrepos.deleteAdminBranchProtectionrepos.setAdminBranchProtectionrepos.getAdminBranchProtectionrepos.deleteBranchProtectionorgs.removePublicMembershipForAuthenticatedUserorgs.setPublicMembershipForAuthenticatedUserorgs.checkPublicMembershipForUserorgs.removeMembershipForUserorgs.setMembershipForUserorgs.getMembershipForUserorgs.checkMembershipForUserorgs.listAppInstallationsorgs.pingHookorgs.deleteHookorgs.updateHookorgs.getHookorgs.createHookorgs.listHooksorgs.removeCredentialAuthorizationorgs.listSamlSsoAuthorizationsrepos.listCommitCommentsForRepogitignore.getAllTemplateslicenses.getAllCommonlyUsedrepos.getProtectedBranchRestrictionspulls.getCommentsForReviewpulls.deleteReviewRequestpulls.createReviewRequestpulls.listReviewRequestspulls.createReviewCommentReplypulls.createCommentpulls.listCommentspulls.deleteCommentpulls.updateCommentpulls.getCommentpulls.listCommentsForRepoprojects.reviewUserPermissionLevelorgs.listPublicEmailsorgs.updateMembershiporgs.listMembershipsusers.deletePublicKeyusers.getPublicKeyusers.createPublicKeyusers.listPublicKeysusers.deleteGpgKeyusers.getGpgKeyusers.createGpgKeyusers.listGpgKeysusers.checkFollowingusers.deleteEmailsForAuthenticatedusers.addEmailsForAuthenticatedusers.listEmailsForAuthenticatedusers.togglePrimaryEmailVisibilityusers.listBlockedscim.removeUserFromOrgscim.updateUserAttributescim.replaceProvisionedUserInformationscim.getProvisioningDetailsForUserscim.provisionAndInviteUsersrepos.getArchiveLinkrepos.createStatusrepos.listAssetsForReleaserepos.requestPageBuildrepos.disbalePagesSiterepos.enablePagesSiterepos.removeDeployKeyrepos.addDeployKeytestPushHookpingHookdeleteHookupdateHookgetHookcreateHooklistHooksrepos.createOrUpdateFilerepos.getContentsrepos.retrieveCommunityProfileMetricsrepos.listStatusesForRefrepos.listCommentsForCommitrepos.removeProtectedBranchUserRestrictionsrepos.addProtectedBranchUserRestrictionsrepos.replaceProtectedBranchUserRestrictionsrepos.removeProtectedBranchTeamRestrictionsrepos.addProtectedBranchTeamRestrictionsrepos.replaceProtectedBranchTeamRestrictionsrepos.removeProtectedBranchAppRestrictionsrepos.addProtectedBranchAppRestrictionsrepos.replaceProtectedBranchAppRestrictionsrepos.deleteAccessRestrictionsrepos.removeProtectedBranchRequiredStatusChecksContextsrepos.addProtectedBranchRequiredStatusChecksContextsrepos.replaceProtectedBranchRequiredStatusChecksContextsrepos.listProtectedBranchRequiredStatusChecksContextsrepos.removeProtectedBranchRequiredStatusChecksrepos.updateProtectedBranchRequiredStatusChecksrepos.getProtectedBranchRequiredStatusChecksrepos.removeProtectedBranchRequiredSignaturesrepos.addProtectedBranchRequiredSignaturesrepos.getProtectedBranchRequiredSignaturesrepos.removeProtectedBranchPullRequestReviewEnforcementrepos.updateProtectedBranchPullRequestReviewEnforcementrepos.getProtectedBranchPullRequestReviewEnforcementrepos.removeProtectedBranchAdminEnforcementrepos.addProtectedBranchAdminEnforcementrepos.getProtectedBranchAdminEnforcementrepos.removeBranchProtectionorgs.concealMembershiporgs.publicizeMembershiporgs.checkPublicMembershiporgs.removeMembershiporgs.addOrUpdateMembershiporgs.getMembershiporgs.checkMembershiporgs.listInstallationsorgs.pingWebhookorgs.deleteWebhookorgs.updateWebhookorgs.getWebhookorgs.createWebhookorgs.listWebhooksorgs.removeSamlSsoAuthorizationorgs.listCredentialAuthorizationsrepos.listCommitComments.gitignore.listTemplateslicenses.listCommonlyUsed…interactions.setRestrictionsForRepo. Deprecates actions.downloadWorkflowJobLogs, actions.getWorkflowJob, actions.listRepoWorkflowRuns, actions.createI…
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)deps: bump @octokit/plugin-rest-endpoint-methods from 3.13.3 to 3.14.0
## 17.9.2 (2020-05-18) ### Bug Fixes * handle deprecated parameters
TypeScript: `octokit.gists.{create,update}({ gist_id, files })
typescript: optional ref parameter for .codeScanning.listAlertsForRepo() method
octokit.codeScanning.{getAlert,listAlertsForRepo}
octokit.actions.downloadWorkflow{Job,Run}logs, octokit.apps.{suspend,unsuspend}Installation. Deprecates octokit.actions.listWorkflow{Job,Run}Logs
typescript: set types for parameters and results/responses automagically
typescript: remove obsolete ?{page,per_page} parameters
typescript: define .defaults() method on rest endpoint method types
typescript: import { RestEndpointMethodTypes } from "@octokit/rest";
octokit.actions.deleteWorkflowRunLogs()
simpler pagination using endpoint methods as first argument
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",
});
TypeScript: method description updates
maintain and triage user permissions in orgs, gambit preview graduated
The previous methods have been deprecated.
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()update @octokit/plugin-rest-endpoint-methods to version 3.3.3 and pin versino in package.json (a492db4), closes #1657
update Octokit.plugin() API to remove deprecation (1c1df88), closes #1654
## 17.1.1 (2020-03-20) ### Bug Fixes * types: export Octokit type
new octokit.reactions.* endpoints. Deprecates octokit.reactions.delete()
octokit.repos.deleteDeployment()octokit.actions.listArtifactsForRepo()octokit.reactions.delete()load all plugins while preserving type information provided to Octokit
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.
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.
octokit.request instead.
octokit.oauthAuthorizations.createAuthorization()octokit.request("POST /authorizations", parameters)octokit.oauthAuthorizations.deleteAuthorization()octokit.request("DELETE /authorizations/:authorization_id", parameters)octokit.oauthAuthorizations.deleteGrant()octokit.request("DELETE /applications/grants/:grant_id", parameters)octokit.oauthAuthorizations.getAuthorization()octokit.request("GET /authorizations/:authorization_id", parameters)octokit.oauthAuthorizations.getGrant()octokit.request("GET /applications/grants/:grant_id", parameters)octokit.oauthAuthorizations.getOrCreateAuthorizationForApp()octokit.request("PUT /authorizations/clients/:client_id", parameters)octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint()octokit.request("PUT /authorizations/clients/:client_id/:fingerprint", parameters)octokit.oauthAuthorizations.listAuthorizations()octokit.request("GET /authorizations", parameters)octokit.oauthAuthorizations.listGrants()octokit.request("GET /applications/grants", parameters)octokit.oauthAuthorizations.updateAuthorization()octokit.request("PATCH /authorizations/:authorization_id", parameters)octokit.pulls.createFromIssue()octokit.request("POST /repos/:owner/:repo/pulls", parameters)octokit.repos.getCommitRefSha()octokit.request("GET /repos/:owner/:repo/commits/:ref", parameters)octokit.teams.addMemberLegacy()octokit.request("PUT /teams/:team_id/members/:username", parameters)octokit.teams.getLegacy()octokit.request("GET /teams/:team_id", parameters)octokit.teams.getMemberLegacy()octokit.request("GET /teams/:team_id/members/:username", parameters)octokit.teams.removeMemberLegacy()octokit.request("DELETE /teams/:team_id/members/:username", 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()octokit.reactions.createForTeamDiscussionCommentLegacy()octokit.reactions.createForTeamDiscussionCommentInOrg()octokit.reactions.listForTeamDiscussionLegacy()octokit.reactions.listForTeamDiscussionInOrg()octokit.reactions.listForTeamDiscussionCommentLegacy()octokit.reactions.listForTeamDiscussionCommentInOrg()octokit.teams.addMemberLegacy()octokit.teams.addMemberInOrg()octokit.teams.addOrUpdateMembershipLegacy()octokit.teams.addOrUpdateMembershipInOrg()octokit.teams.addOrUpdateProjectLegacy()octokit.teams.addOrUpdateProjectInOrg()octokit.teams.addOrUpdateRepoLegacy()octokit.teams.addOrUpdateRepoInOrg()octokit.teams.checkManagesRepoLegacy()octokit.teams.checkManagesRepoInOrg()octokit.teams.createDiscussionLegacy()octokit.teams.createDiscussionInOrg()octokit.teams.createDiscussionCommentLegacy()octokit.teams.createDiscussionCommentInOrg()octokit.teams.deleteLegacy()octokit.teams.deleteInOrg()octokit.teams.deleteDiscussionLegacy()octokit.teams.deleteDiscussionInOrg()octokit.teams.deleteDiscussionCommentLegacy()octokit.teams.deleteDiscussionCommentInOrg()octokit.teams.getLegacy()octokit.teams.getInOrg()octokit.teams.getDiscussionLegacy()octokit.teams.getDiscussionInOrg()octokit.teams.getDiscussionCommentLegacy()octokit.teams.getDiscussionCommentInOrg()octokit.teams.getMemberLegacy()octokit.teams.getMemberInOrg()octokit.teams.getMembershipLegacy()octokit.teams.getMembershipInOrg()octokit.teams.listChildLegacy()octokit.teams.listChildInOrg()octokit.teams.listDiscussionCommentsLegacy()octokit.teams.listDiscussionCommentsInOrg()octokit.teams.listDiscussionsLegacy()octokit.teams.listDiscussionsInOrg()octokit.teams.listMembersLegacy()octokit.teams.listMembersInOrg()octokit.teams.listPendingInvitationsLegacy()octokit.teams.listPendingInvitationsInOrg()octokit.teams.listProjectsLegacy()octokit.teams.listProjectsInOrg()octokit.teams.listReposLegacy()octokit.teams.listReposInOrg()octokit.teams.removeMemberLegacy()octokit.teams.removeMemberInOrg()octokit.teams.removeMembershipLegacy()octokit.teams.removeMembershipInOrg()octokit.teams.removeProjectLegacy()octokit.teams.removeProjectInOrg()octokit.teams.removeRepoLegacy()octokit.teams.removeRepoInOrg()octokit.teams.reviewProjectLegacy()octokit.teams.reviewProjectInOrg()octokit.teams.updateLegacy()octokit.teams.updateInOrg()octokit.teams.updateDiscussionLegacy()octokit.teams.updateDiscussionInOrg()octokit.teams.updateDiscussionCommentLegacy()octokit.teams.updateDiscussionCommentInOrg()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
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 Update: resolved via #1650{ Octokit } is no longer a type, only a value. Use typeof Octokit instead #1624
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
ownerreporelease_idPassing url will still work, but is not recommended. Use octokit.request instead:
octokit.request(url, {
method: "POST",
...parameters
})
<a name="typescript"></a>
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 "@octokit/rest";
// for `octokit.checks.create()`
RestEndpointMethodTypes["checks"]["create"]["parameters"]
RestEndpointMethodTypes["checks"]["create"]["response"]
@octokit/plugin-rest-endpoint-methods v3.0.0
octokit instance typeing (octokit.paginate(), endpoint methods)
octokit instance typeing (octokit.paginate(), endpoint methods) (200f51e)Your coding agent can read these notes before it upgrades. Set up the MCP server →