[Snyk] Upgrade octokit from 1.0.0-hello-world to 1.8.1 #308
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Snyk has created this PR to upgrade octokit from 1.0.0-hello-world to 1.8.1. See this package in npm: octokit See this project in Snyk: https://app.snyk.io/org/sammytezzy/project/19d599fd-9f38-4c7f-95ca-753ff5501349?utm_source=github&utm_medium=referral&page=upgrade-pr
|
|
|
Reviewer's Guide by SourceryThis PR upgrades the octokit dependency from version 1.0.0-hello-world to 1.8.1. The upgrade spans 21 versions and includes numerous new features, bug fixes, and API improvements. The changes are primarily focused on updating the octokit REST API client with new endpoints and parameter updates. Class diagram for updated Octokit clientclassDiagram
class Octokit {
+rest
}
class Rest {
+dependabot
+teams
+enterpriseAdmin
+actions
+codespaces
+repos
+orgs
+secretScanning
+billing
+migrations
+users
+projects
+reactions
+checks
}
class Dependabot {
+addSelectedRepoToOrgSecret()
+removeSelectedRepoFromOrgSecret()
+getOrgSecret()
+createOrUpdateOrgSecret()
+deleteOrgSecret()
+getRepoSecret()
+createOrUpdateRepoSecret()
+deleteRepoSecret()
+listSelectedReposForOrgSecret()
+setSelectedReposForOrgSecret()
+getOrgPublicKey()
+listOrgSecrets()
+getRepoPublicKey()
+listRepoSecrets()
}
class Teams {
+listLinkedExternalIdpGroupsToTeamForOrg()
+linkExternalIdpGroupToTeamForOrg()
+unlinkExternalIdpGroupFromTeamForOrg()
+externalIdpGroupInfoForOrg()
+listExternalIdpGroupsForOrg()
}
class EnterpriseAdmin {
+listLabelsForSelfHostedRunnerForEnterprise()
+addCustomLabelsToSelfHostedRunnerForEnterprise()
+setCustomLabelsForSelfHostedRunnerForEnterprise()
+removeAllCustomLabelsFromSelfHostedRunnerForEnterprise()
+removeCustomLabelFromSelfHostedRunnerForEnterprise()
+getServerStatistics()
+listSelfHostedRunnerGroupsForEnterprise()
}
class Actions {
+listLabelsForSelfHostedRunnerForOrg()
+addCustomLabelsToSelfHostedRunnerForOrg()
+setCustomLabelsForSelfHostedRunnerForOrg()
+removeAllCustomLabelsFromSelfHostedRunnerForOrg()
+removeCustomLabelFromSelfHostedRunnerForOrg()
+listLabelsForSelfHostedRunnerForRepo()
+addCustomLabelsToSelfHostedRunnerForRepo()
+setCustomLabelsForSelfHostedRunnerForRepo()
+removeAllCustomLabelsFromSelfHostedRunnerForRepo()
+removeCustomLabelFromSelfHostedRunnerForRepo()
+getGithubActionsDefaultWorkflowPermissionsOrganization()
+setGithubActionsDefaultWorkflowPermissionsOrganization()
+getWorkflowAccessToRepository()
+setWorkflowAccessToRepository()
+getGithubActionsDefaultWorkflowPermissionsRepository()
+setGithubActionsDefaultWorkflowPermissionsRepository()
+getActionsCacheUsageForOrg()
+getActionsCacheUsageForEnterprise()
+getActionsCacheUsage()
+listWorkflowRunsForRepo()
+listWorkflowRuns()
+reRunJobForWorkflowRun()
+reRunWorkflowFailedJobs()
+reRunWorkflow()
+updateSelfHostedRunnerGroupForOrg()
+createSelfHostedRunnerGroupForOrg()
}
class Codespaces {
+listInRepositoryForAuthenticatedUser()
+createWithRepoForAuthenticatedUser()
+listForAuthenticatedUser()
+createForAuthenticatedUser()
+listSecretsForAuthenticatedUser()
+getPublicKeyForAuthenticatedUser()
+getSecretForAuthenticatedUser()
+createOrUpdateSecretForAuthenticatedUser()
+deleteSecretForAuthenticatedUser()
+listRepositoriesForSecretForAuthenticatedUser()
+setRepositoriesForSecretForAuthenticatedUser()
+addRepositoryForSecretForAuthenticatedUser()
+removeRepositoryForSecretForAuthenticatedUser()
+getForAuthenticatedUser()
+updateForAuthenticatedUser()
+deleteForAuthenticatedUser()
+exportForAuthenticatedUser()
+getExportDetailsForAuthenticatedUser()
+codespaceMachinesForAuthenticatedUser()
+startForAuthenticatedUser()
+stopForAuthenticatedUser()
+getRepoSecret()
+createOrUpdateRepoSecret()
+deleteRepoSecret()
+listDevcontainersInRepositoryForAuthenticatedUser()
+repoMachinesForAuthenticatedUser()
+getRepoPublicKey()
+listRepoSecrets()
+createWithPrForAuthenticatedUser()
}
class Repos {
+listTagProtection()
+createTagProtection()
+deleteTagProtection()
+codeownersErrors()
+diffRange()
+listForAuthenticatedUser()
+createForAuthenticatedUser()
+getAllEnvironments()
+updatePullRequestReviewProtection()
+updateStatusCheckProtection()
+update()
+createInOrg()
+mergeUpstream()
+enableLfsForRepo()
+disableLfsForRepo()
+generateReleaseNotes()
}
class Orgs {
+listCustomRoles()
+listSamlSsoAuthorizations()
+update()
+convertMemberToOutsideCollaborator()
}
class SecretScanning {
+listAlertsForEnterprise()
+listAlertsForOrg()
+listAlertsForRepo()
+listLocationsForAlert()
}
class Billing {
+getGithubAdvancedSecurityBillingGhe()
+getGithubAdvancedSecurityBillingOrg()
}
class Migrations {
+startForOrg()
+startForAuthenticatedUser()
}
class Users {
+createGpgKeyForAuthenticatedUser()
}
class Projects {
+getPermissionForUser()
}
class Reactions {
+deleteForRelease()
+listForRelease()
}
class Checks {
+rerequestRun()
}
Octokit --> Rest
Rest --> Dependabot
Rest --> Teams
Rest --> EnterpriseAdmin
Rest --> Actions
Rest --> Codespaces
Rest --> Repos
Rest --> Orgs
Rest --> SecretScanning
Rest --> Billing
Rest --> Migrations
Rest --> Users
Rest --> Projects
Rest --> Reactions
Rest --> Checks
note for Octokit "This class represents the main client for interacting with GitHub's REST API."
note for Rest "This class contains all the REST API endpoints available in the Octokit client."
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Snyk has created this PR to upgrade octokit from 1.0.0-hello-world to 1.8.1.
ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
The recommended version is 21 versions ahead of your current version.
The recommended version was released on 2 years ago.
Release notes
Package name: octokit
-
1.8.1 - 2022-06-22
- set correct user agent (#2231) (de8c3a5)
-
1.8.0 - 2022-06-15
- remove defunkt
- remove defunkt
-
1.7.2 - 2022-06-08
- re-enable throttling plugin (#2224) (124a9f0)
-
1.7.1 - 2021-11-22
- docs: correct proxy servers headline not rendering (#2169) (163f925)
-
1.7.0 - 2021-10-07
-
1.6.2 - 2021-09-30
- removes defunkt endpoints:
- deps:
-
1.6.1 - 2021-09-24
- graduate previews
-
1.6.0 - 2021-09-22
-
1.5.0 - 2021-08-31
- typescript:
- typescript: fix type for
-
1.4.0 - 2021-08-10
- typescript:
-
1.3.0 - 2021-08-03
-
1.2.0 - 2021-08-02
-
1.1.0 - 2021-06-23
-
1.0.6 - 2021-06-11
-
1.0.5 - 2021-05-18
-
1.0.4 - 2021-05-07
-
1.0.3 - 2021-04-18
-
1.0.3-debug.1 - 2021-04-25
-
1.0.2 - 2021-04-15
-
1.0.1 - 2021-04-13
-
1.0.0 - 2021-04-08
-
1.0.0-hello-world - 2018-05-31
from octokit GitHub release notes1.8.1 (2022-06-22)
Bug Fixes
Features
.rest.dependabot.addSelectedRepoToOrgSecret().rest.dependabot.removeSelectedRepoFromOrgSecret().rest.teams.listLinkedExternalIdpGroupsToTeamForOrg().rest.teams.linkExternalIdpGroupToTeamForOrg().rest.teams.unlinkExternalIdpGroupFromTeamForOrg().rest.enterpriseAdmin.listLabelsForSelfHostedRunnerForEnterprise().rest.enterpriseAdmin.addCustomLabelsToSelfHostedRunnerForEnterprise().rest.enterpriseAdmin.setCustomLabelsForSelfHostedRunnerForEnterprise().rest.enterpriseAdmin.removeAllCustomLabelsFromSelfHostedRunnerForEnterprise().rest.actions.listLabelsForSelfHostedRunnerForOrg().rest.actions.addCustomLabelsToSelfHostedRunnerForOrg().rest.actions.setCustomLabelsForSelfHostedRunnerForOrg().rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForOrg().rest.actions.listLabelsForSelfHostedRunnerForRepo().rest.actions.addCustomLabelsToSelfHostedRunnerForRepo().rest.actions.setCustomLabelsForSelfHostedRunnerForRepo().rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForRepo().rest.codespaces.listInRepositoryForAuthenticatedUser().rest.codespaces.createWithRepoForAuthenticatedUser().rest.repos.listTagProtection().rest.repos.createTagProtection().rest.codespaces.listForAuthenticatedUser().rest.codespaces.createForAuthenticatedUser().rest.codespaces.listSecretsForAuthenticatedUser().rest.codespaces.getPublicKeyForAuthenticatedUser().rest.codespaces.getSecretForAuthenticatedUser().rest.codespaces.createOrUpdateSecretForAuthenticatedUser().rest.codespaces.deleteSecretForAuthenticatedUser().rest.codespaces.listRepositoriesForSecretForAuthenticatedUser().rest.codespaces.setRepositoriesForSecretForAuthenticatedUser().rest.codespaces.addRepositoryForSecretForAuthenticatedUser().rest.codespaces.removeRepositoryForSecretForAuthenticatedUser().rest.codespaces.getForAuthenticatedUser().rest.codespaces.updateForAuthenticatedUser().rest.codespaces.deleteForAuthenticatedUser().rest.codespaces.exportForAuthenticatedUser().rest.codespaces.getExportDetailsForAuthenticatedUser().rest.codespaces.codespaceMachinesForAuthenticatedUser().rest.codespaces.startForAuthenticatedUser().rest.codespaces.stopForAuthenticatedUser().rest.dependabot.getOrgSecret().rest.dependabot.createOrUpdateOrgSecret().rest.dependabot.deleteOrgSecret().rest.codespaces.getRepoSecret().rest.codespaces.createOrUpdateRepoSecret().rest.codespaces.deleteRepoSecret().rest.dependabot.getRepoSecret().rest.dependabot.createOrUpdateRepoSecret().rest.dependabot.deleteRepoSecret().rest.actions.getGithubActionsDefaultWorkflowPermissionsOrganization().rest.actions.setGithubActionsDefaultWorkflowPermissionsOrganization().rest.dependabot.listSelectedReposForOrgSecret().rest.dependabot.setSelectedReposForOrgSecret().rest.actions.getWorkflowAccessToRepository().rest.actions.setWorkflowAccessToRepository().rest.actions.getGithubActionsDefaultWorkflowPermissionsRepository().rest.actions.setGithubActionsDefaultWorkflowPermissionsRepository().rest.orgs.listCustomRoles().rest.actions.getActionsCacheUsageForOrg().rest.enterpriseAdmin.removeCustomLabelFromSelfHostedRunnerForEnterprise().rest.actions.removeCustomLabelFromSelfHostedRunnerForOrg().rest.actions.removeCustomLabelFromSelfHostedRunnerForRepo().rest.reactions.deleteForRelease().rest.repos.deleteTagProtection().rest.enterpriseAdmin.getServerStatistics().rest.actions.getActionsCacheUsageForEnterprise().rest.actions.getGithubActionsDefaultWorkflowPermissionsEnterprise().rest.enterpriseAdmin.listSelfHostedRunnerGroupsForEnterprise()-visible-to-organizationparamter.rest.secretScanning.listAlertsForEnterprise().rest.billing.getGithubAdvancedSecurityBillingGhe().rest.actions.getActionsCacheUsageByRepoForOrg().rest.actions.listSelfHostedRunnerGroupsForOrg()- new parameter:visible_to_repository.rest.codeScanning.listAlertsForOrg().rest.orgs.listSamlSsoAuthorizations()- new parameters:per_page,page,login.rest.dependabot.getOrgPublicKey().rest.dependabot.listOrgSecrets().rest.teams.externalIdpGroupInfoForOrg().rest.teams.listExternalIdpGroupsForOrg().rest.secretScanning.listAlertsForOrg()- new parameters:sort,direction.rest.billing.getGithubAdvancedSecurityBillingOrg().rest.repos.codeownersErrors().rest.codespaces.listDevcontainersInRepositoryForAuthenticatedUser().rest.codespaces.repoMachinesForAuthenticatedUser().rest.codespaces.getRepoPublicKey().rest.codespaces.listRepoSecrets().rest.dependabot.getRepoPublicKey().rest.dependabot.listRepoSecrets().rest.dependencyGraph.diffRange().rest.reactions.listForRelease().rest.secretScanning.listLocationsForAlert().rest.actions.updateSelfHostedRunnerGroupForOrg()- new parameters:allows_public_repositories,restricted_to_workflows,selected_workflows.rest.orgs.update()- new parameter:members_can_fork_private_repositories.rest.actions.createSelfHostedRunnerGroupForOrg()- new parameters:allows_public_repositories,restricted_to_workflows,selected_workflows.rest.migrations.startForOrg()- new parrameters:exclude_metadata,exclude_git_data,org_metadata_only.rest.repos.createInOrg()- new parameter:use_squash_pr_title_as_default.rest.actions.reRunJobForWorkflowRun().rest.actions.reRunWorkflowFailedJobs().rest.codespaces.createWithPrForAuthenticatedUser().rest.migrations.startForAuthenticatedUser()- new parrameters:exclude_metadata,exclude_git_data,org_metadata_only.rest.actions.setGithubActionsDefaultWorkflowPermissionsEnterprise().rest.orgs.convertMemberToOutsideCollaborator()- new parameter:async.rest.actions.getActionsCacheUsage().rest.actions.listWorkflowRunsForRepo(): new parameter:check_suite_id.rest.actions.listWorkflowRuns(): new parameter:check_suite_id.rest.codeScanning.listAlertsForRepo(): new parameters:direction,sort.rest.repos.getAllEnvironments(): new parameters:per_page,page.rest.secretScanning.listAlertsForRepo(): new parameters:direction,sort.rest.repos.updatePullRequestReviewProtection(): new parameters:dismissal_restrictions.apps,bypass_pull_request_allowances.rest.repos.updateStatusCheckProtection(): new parameter:checks.rest.codeScanning.updateAlert(): new parameter:dismissed_comment.rest.repos.update():secret_scanning_push_protection,use_squash_pr_title_as_default.rest.actions.reRunWorkflow(): new parameter:enable_debug_logging.rest.users.createGpgKeyForAuthenticatedUser(): new parameter:name.rest.repos.updateBranchProtection(): new parameter:required_status_checks.checks,required_pull_request_reviews.{apps,bypass_pull_request_allowances},block_creationsBug Fixes
.rest.apps.createFromManifest()has no request body.rest.projects.getPermissionForUser(): correct response type and example.rest.repos.update():visibilityparameter cannot be set tovisibility.rest.actions.reRunWorkflow(): no longer deprecated.rest.reactions.deleteLegacy().rest.apps.createContentAttachment()1.7.2 (2022-06-08)
Bug Fixes
1.7.1 (2021-11-22)
Bug Fixes
1.7.0 (2021-10-07)
Features
.actions.downloadWorkflowRunAttemptLogs(),.actions.getWorkflowRunAttempt(),.repos.generateReleaseNotes(),.checks.rerequestRun(). Graduatenebula,zzzax,switcheroo,baptistepreviews. Removes defunkt/repos/{owner}/{repo}/actions/runs/{run_id}/retryendpoint. Renames methods to have consistentAuthenticatedUser()suffix, deprecates previous method names (#2163) (e02541c)1.6.2 (2021-09-30)
Bug Fixes
GET /repos/{owner}/{repo}/community/code_of_conduct,DELETE /reactions/{reaction_id}.encrypted_valueandkey_idparameters are required for.rest.actions.{createOrUpdateEnvironmentSecret,setSelectedReposForOrgSecret}().access_tokenparameter is required for.rest.apps.deleteAuthorization(). Previews graduated:ant-man,flash,scarlet-witch,squirrel-girl(03e3055)luke-cagepreview graduated (#2158) (6864592)1.6.1 (2021-09-24)
Bug Fixes
dorian,inertia,london,lydian,wyandotte(#2157) (6d878ac)1.6.0 (2021-09-22)
Features
octokit.rest.repos.{enable,disable}LfsForRepo(),octokit.rest.repos.mergeUpstream({ owner, repo, branch })(7e3cd91)1.5.0 (2021-08-31)
Features
.rest.packages.deletePackageForUser(),.rest.packages.deletePackageVersionForUser(),.rest.packages.restorePackageForUser(),.rest.packages.restorePackageVersionForUser(),.rest.secretScanning.listAlertsForOrg()(#2150) (670986f)Bug Fixes
labelsparameter in.issues.{add,set}Labels()(#2150) (670986f)1.4.0 (2021-08-10)
Features
permissionskey in responses now consistently includemaintainandtriageroles (#2145) (b47bf5c)Important
Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.
For more information:
Summary by Sourcery
Enhancements: