Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Explain differencs in CWD when run in a composite action #368

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: Explain differencs in CWD when run in a composite action
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.
  • Loading branch information
dekimsey authored Apr 17, 2023
commit d80194e53087a64ca2127b43ebf20a08302ae8bd
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -322,6 +322,23 @@ Additionally, you'll want to use the [checkout
action](https://github.com/actions/checkout) to make sure your script file is
available.

### Running in Composite Actions

When used from a composite-action the current working directory is the invoking workflow,
*not* the composite action's. Be sure to use an absolute path to any of the action's
resources in this case like so:

```yaml
name: My Composite Action Using Github Scripts
runs:
using: "composite"
steps:
- uses: actions/github-script@v6
script: |
const script = require(process.env.GITHUB_ACTION_PATH + '/my-action-main.js')
console.log(script({context, core})
```

### Run a separate file with an async function

You can also use async functions in this manner, as long as you `await` it in