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()
... (truncated)
Commits
b4ab0db remove all APIS deprecated in v17 or earlier (#1760)
5306f37 fix: Revert "fix(deps): bump @octokit/plugin-rest-endpoint-methods from 3.17....
80549bf fix(deps): bump @octokit/plugin-rest-endpoint-methods from 3.17.0 to 4.0.0
0f27192 build(deps): bump @octokit/plugin-paginate-rest from 2.2.1 to 2.2.2
155caef build(deps-dev): bump @octokit/request from 5.4.4 to 5.4.5
401ccdb build(deps-dev): bump @types/jest from 25.2.3 to 26.0.0
0387058 build(deps-dev): bump @types/node from 14.0.11 to 14.0.12
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme
Additionally, you can set the following in the `.dependabot/config.yml` file in this repo:
- Update frequency
- Automerge options (never/patch/minor, and dev/runtime dependencies)
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)
Bumps @octokit/rest from 17.11.0 to 18.0.0.
Release notes
Sourced from @octokit/rest's releases.
Commits
b4ab0db
remove all APIS deprecated in v17 or earlier (#1760)5306f37
fix: Revert "fix(deps): bump @octokit/plugin-rest-endpoint-methods from 3.17....80549bf
fix(deps): bump @octokit/plugin-rest-endpoint-methods from 3.17.0 to 4.0.00f27192
build(deps): bump @octokit/plugin-paginate-rest from 2.2.1 to 2.2.2155caef
build(deps-dev): bump @octokit/request from 5.4.4 to 5.4.5401ccdb
build(deps-dev): bump @types/jest from 25.2.3 to 26.0.00387058
build(deps-dev): bump @types/node from 14.0.11 to 14.0.12Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme Additionally, you can set the following in the `.dependabot/config.yml` file in this repo: - Update frequency - Automerge options (never/patch/minor, and dev/runtime dependencies) - Out-of-range updates (receive only lockfile updates, if desired) - Security updates (receive only security updates, if desired)