Update dependency actions-toolkit to v5 #12
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 PR contains the following updates:
^4.0.0->^5.0.0By merging this PR, the issue #5 will be automatically resolved and closed:
Release Notes
JasonEtco/actions-toolkit (actions-toolkit)
v5.0.0Compare Source
Breaking Changes
There are a couple of major improvements that are unfortunately breaking changes:
tools.context.issuereturns a different objectThanks to @mheap,
tools.context.issuenow returns{ owner, repo, issue_number }instead of{ owner, repo, number }. This is due to a change in the Octokit SDK. To have parity with pull requests, there is now alsotools.context.pullRequest, which returns{ owner, repo, pull_number }.See #118 for more information!
Toolkit#getFileis nowToolkit#readFileThe
getFilemethod has been renamed toreadFile, and the behavior has changed. It now usesfs.promises.readFileunder the hood, so it returns a promise:See #121 for more information!
tools.storehas been removedThis feature was added before the Actions runtime had a way to share data between actions. That now exists in the platform, as "outputs"! See #125 for the removal of
Store, and #120 for it's "replacement",tools.outputs(thanks to @abouroubi ✨):Toolkit#runInWorkspaceis nowToolkit#execThis method was useful, but
@actions/execis built more with the Actions runner in mind. So, nowToolkit#execcalls@actions/exec! This will be more stable for the finicky, ephemeral environments of Actions.See #123 for more information!
What’s Changed