diff --git a/README.md b/README.md index 8e08984ee..a3197e0e6 100644 --- a/README.md +++ b/README.md @@ -198,17 +198,16 @@ jobs: - uses: actions/github-script@v2 with: script: | - const path = require('path') - const scriptPath = path.resolve('./path/to/script.js') - console.log(require(scriptPath)({context})) + const script = require(`${process.env.GITHUB_WORKSPACE}/path/to/script.js`) + console.log(script({github, context})) ``` -*Note that the script path given to `require()` must be an absolute path in this case, hence the call to `path.resolve()`.* +*Note that the script path given to `require()` must be an **absolute path** in this case, hence using [`GITHUB_WORKSPACE`](https://docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables).* And then export a function from your module: ```javascript -module.exports = ({context}) => { +module.exports = (github, context) => { return context.payload.client_payload.value } ```