mirror of
https://github.com/actions/github-script.git
synced 2025-12-08 16:16:21 +00:00
Document how to use installed npm packages
This commit is contained in:
32
README.md
32
README.md
@@ -71,7 +71,7 @@ in case you need to use a non-default token.
|
|||||||
|
|
||||||
By default, github-script will use the token provided to your workflow.
|
By default, github-script will use the token provided to your workflow.
|
||||||
|
|
||||||
### Print the available attributes of context:
|
### Print the available attributes of context
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- name: View context attributes
|
- name: View context attributes
|
||||||
@@ -200,7 +200,6 @@ contain the actual diff text.
|
|||||||
You can use the `github.graphql` object to run custom GraphQL queries against the GitHub API.
|
You can use the `github.graphql` object to run custom GraphQL queries against the GitHub API.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
list-issues:
|
list-issues:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -225,7 +224,6 @@ jobs:
|
|||||||
}
|
}
|
||||||
const result = await github.graphql(query, variables)
|
const result = await github.graphql(query, variables)
|
||||||
console.log(result)
|
console.log(result)
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Run a separate file
|
### Run a separate file
|
||||||
@@ -268,3 +266,31 @@ external function.
|
|||||||
Additionally, you'll want to use the [checkout
|
Additionally, you'll want to use the [checkout
|
||||||
action](https://github.com/actions/checkout) to make sure your script file is
|
action](https://github.com/actions/checkout) to make sure your script file is
|
||||||
available.
|
available.
|
||||||
|
|
||||||
|
### Use npm packages
|
||||||
|
|
||||||
|
Like importing your own files above, you can also use installed modules:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
on: push
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
echo-input:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- uses: actions/setup-node@v2
|
||||||
|
with:
|
||||||
|
node-version: 14
|
||||||
|
- run: npm ci
|
||||||
|
# or one-off:
|
||||||
|
- run: npm install -g execa
|
||||||
|
- uses: actions/github-script@v3
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
const execa = require(`${process.env.GITHUB_WORKSPACE}/node_modules/execa`)
|
||||||
|
|
||||||
|
const { stdout } = await execa('echo', ['hello', 'world'])
|
||||||
|
|
||||||
|
console.log(stdout)
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user