Replace @action/github dependency with latest Octokit
#614
Conversation
This file contains hidden or 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
joshmgross
commented
Jun 3, 2025
Comment on lines
+4
to
+5
| "module": "Node16", | ||
| "moduleResolution": "node16", |
There was a problem hiding this comment.
It appears all of the newer Octokit libraries require this - https://github.com/octokit/action.js/blob/25f537f58b9d8ee779175a9601f0958b1b2ce6ac/README.md#L33-L37
| "author": "GitHub", | ||
| "license": "MIT", | ||
| "main": "dist/index.js", | ||
| "type": "module", |
There was a problem hiding this comment.
I'm fairly certain this was required when updating Octokit, I don't think it should impact much since this action isn't consumed as a library.
My one concern is that it somehow impacts the custom require functionality this action implements, but integration tests should catch that.
dist/index.js
Outdated
There was a problem hiding this comment.
I'm not entirely sure why the dist is so bloated now
joshmgross
commented
Jun 3, 2025
| id: my-script | ||
| with: | ||
| result-encoding: string | ||
| retries: 3 | ||
| script: | | ||
| github.rest.issues.get({ | ||
| octokit.rest.issues.get({ |
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.
This replaces the dependency of
@actions/githubwith a more direct dependency on Octokit via@octokit/action- https://github.com/octokit/action.js.@actions/githubis on a very old version of Octokit and is preventing users of this action from using the latest GitHub APIs in their scripts:Using Octokit in a more direct manner will allow this action to keep up date with dependencies in a more timely manner going forward.
This will likely break some user scripts, both from "expected" breaking changes from a multi-version bump of Octokit and unexpected breakages from new or different behavior in
@octokit/actionor this action that we're not correctly replicating from@actions/github. My hope is that integration tests will catch the more significant scenarios, but we should expect some bugs with the v8 version of this action once it's released - #556.