- Notifications
You must be signed in to change notification settings - Fork455
doc: Explain differencs in CWD when run in a composite action#368
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
dekimsey wants to merge1 commit intoactions:mainChoose a base branch fromdekimsey:doc-caveat-path-in-composite-actions
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
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
This documents an easy to make mistake regarding howto require a resource from the action's source. When a relativepath is used, the CWD is the workflow's not the compositeaction's. This surfaces to calling workflows as a`MODULE_NOT_FOUND` error.
kf6kjg commentedJul 8, 2024
Looks like it's time for an update of this PR :) |
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
This documents an easy to make mistake regarding how to require a resource from the action's source. When a relative
path is used, the CWD is the workflow's not the composite action's. This surfaces to calling workflows as a
MODULE_NOT_FOUND
error.With respect to the code-sample, ideally we'd use the
github.action_path
(or soon,github.host-workspace
) context in our example. But untilactions/runner#2517 is completed, at this time it's safer to useprocess.env.GITHUB_ACTION_PATH
which is correct regardless of how the action is invoked.