Upgrading octokit 4 to 5
Breaking4.25.1 → 5.6.1Breaking2Platform1New12Changed2Fixed2Other9
BreakingUpgrade verdict
2 breaking changes and a platform requirement change.
In plain terms
- The library no longer adds special preview headers to API requests, because GitHub made those preview features permanent.
- The code that handled API previews is gone from the library.
- This version no longer works on older Ruby versions 2.0 to 2.6, which are no longer maintained. You need a newer Ruby to use it.
Must act 3 items need code or config changes
Ruby requirement changed in 5.0.0: >= 2.0.0 → >= 2.7.0.
What you must change
Breaking2
Removes all REST API preview logic and header implementations now that GitHub previews have been promoted.
Removes REST API previews logic from the SDK now that all previews have been promoted.
Platform1
Drops support for Ruby versions 2.0 through 2.6, which have reached end-of-life.
API changes
Generated by DepDelta from published Ruby source. Not mixed with prose notes.
- removed:
const Preview.PREVIEW_TYPES - removed:
method Preview.ensure_api_media_type(_, _) - removed:
method Preview.warn_preview(_) - removed:
module Preview
- added:
method ActionsArtifacts.artifact(_, _, _ = …) - added:
method ActionsArtifacts.artifact_download_url(_, _, _ = …) - added:
method ActionsArtifacts.delete_artifact(_, _, _ = …) - added:
method ActionsArtifacts.repository_artifacts(_, _ = …) - added:
method ActionsArtifacts.workflow_run_artifacts(_, _, _ = …) - added:
method ActionsWorkflowJobs.list_workflow_run_attempt_jobs(_, _, _, _ = …) - added:
method ActionsWorkflowJobs.list_workflow_run_jobs(_, _, _ = …) - added:
method ActionsWorkflowJobs.workflow_run_attempt_jobs(_, _, _, _ = …) - added:
method ActionsWorkflowJobs.workflow_run_job(_, _, _ = …) - added:
method ActionsWorkflowJobs.workflow_run_job_logs(_, _, _ = …) - added:
method ActionsWorkflowJobs.workflow_run_jobs(_, _, _ = …) - added:
method ActionsWorkflowRuns.workflow_run_usage(_, _, _ = …) - added:
method ActionsWorkflows.workflow_disable(_, _, _ = …) - added:
method ActionsWorkflows.workflow_enable(_, _, _ = …) - added:
method Organizations.organization_audit_log(_, _ = …) - added:
method Organizations.team_permissions_for_repo(_, _, _, _, _ = …) - added:
method PullRequests.update_pull_request_branch(_, _, _ = …) - added:
method Search.search_topics(_, _ = …) - added:
module ActionsArtifacts - added:
module ActionsWorkflowJobs