Skip to content

v18.0.0
Compare
Choose a tag to compare
@gr2m gr2m released this 18 Apr 18:03
· 506 commits to main since this release
v18.0.0
b4ab0db
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Upgrade guide

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()
Assets 2
Loading