docs: use GITHUB_WORKSPACE environment variable

- update example for using `GITHUB_WORKSPACE` environment variable to keep things simple, and use less steps
- include `github` object as a parameter to the sample script to better illustrate usage
This commit is contained in:
Ahmad Nassri
2020-07-28 21:54:19 -04:00
committed by GitHub
parent 83107c8695
commit a656f437f9

View File

@@ -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)*
And then export a function from your module:
```javascript
module.exports = ({context}) => {
module.exports = (github, context) => {
return context.payload.client_payload.value
}
```