doc: Explain differencs in CWD when run in a composite action #368
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
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.
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 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_FOUNDerror.With respect to the code-sample, ideally we'd use the
github.action_path(or soon,github.host-workspace) context in our example. But until actions/runner#2517 is completed, at this time it's safer to useprocess.env.GITHUB_ACTION_PATHwhich is correct regardless of how the action is invoked.