Skip to content

Commit

Permalink
Merge pull request #240 from actions/joshmgross/document-esm
Browse files Browse the repository at this point in the history
Add an example using ESM `import`
  • Loading branch information
joshmgross authored Feb 11, 2022
2 parents 53cdbb4 + 5541733 commit 9ac0880
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,31 @@ jobs:
console.log(stdout)
```
### Use ESM `import`

To import an ESM file, you'll need to reference your script by an absolute path and ensure you have a `package.json` file with `"type": "module"` specified.
For a script in your repository `src/print-stuff.js`:
```js
export default function printStuff() { console.log('stuff') }
```

```yaml
on: push
jobs:
print-stuff:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/github-script@v6
with:
script: |
const { default: printStuff } = await import('${{ github.workspace }}/src/print-stuff.js')
await printStuff()
```

### Use env as input

You can set env vars to use them in your script:
Expand Down

0 comments on commit 9ac0880

Please sign in to comment.