Conditionally stub libraries #170
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the logic for conditionally stubbing the @actions/toolkit libraries so that only the libraries declared in package.json are stubbed.
- Updated ESM branch logic to remove fallback values when resolving stubs.
- Adjusted commonJS branch to include conditional stubbing for each library.
Files not reviewed (1)
- package.json: Language not supported
Comments suppressed due to low confidence (3)
src/commands/run.ts:340
- [nitpick] Since the if-condition already ensures that stubs['@actions/github'].base is defined, the fallback operator (?? '') is redundant; consider removing it for consistency with the ESM branch.
stubs['@actions/github'].base ?? ''
src/commands/run.ts:349
- [nitpick] Removing the fallback (?? '') here would align the commonJS branch with the ESM branch, as the presence of a non-null base is already checked.
stubs['@actions/core'].base ?? ''
src/commands/run.ts:358
- [nitpick] For consistency, eliminate the fallback operator (?? '') as the corresponding if-condition guarantees that stubs['@actions/artifact'].base is defined.
stubs['@actions/artifact'].base ?? ''
Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more
🦙 MegaLinter status: ❌ ERROR
See detailed report in MegaLinter reports
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the stubbing logic so that only the stubs associated with installed libraries are loaded. Key changes include:
- Adding conditional checks for each @actions/* stub (GitHub, Core, Artifact) before stubbing.
- Removing the fallback value (using the nullish coalescing operator) in the path resolution for each stub.
- Applying the same conditional logic for both ESM and non-ESM action types.
Files not reviewed (1)
- package.json: Language not supported
Comments suppressed due to low confidence (1)
src/commands/run.ts:297
- Ensure that stubs['@actions/github'].base always contains a valid string value. If it may be an empty string, the condition check might inadvertently skip the stubbing logic.
stubs['@actions/github'].base,
Tip: Copilot code review supports C#, Go, Java, JavaScript, Markdown, Python, Ruby and TypeScript, with more languages coming soon. Learn more
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.
See #168
The issue appears to arise because
@github/local-actionis attempting to stub all of the supported@actions/toolkitlibraries, regardless of whether or not they are installed in the action'spackage.json. This PR updates the logic to only stub libraries that are actually present in the project.