Skip to content

Document how to use npm packages and env input #126

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.

Sign up for GitHub

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

Merged
joshmgross merged 3 commits into from
Mar 29, 2021
Merged

Document how to use npm packages and env input #126

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a56d450
Document how to use installed npm packages
nihalgonsalves Mar 29, 2021
934655b
Document how to use `env:` as input
nihalgonsalves Mar 29, 2021
01dfe2e
Update README.md
nihalgonsalves Mar 29, 2021
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
56 changes: 52 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,14 @@ in case you need to use a non-default token.

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
- name: View context attributes
uses: actions/github-script@v3
with:
script: console.log(context)
```
```

### Comment on an issue

Expand Down Expand Up @@ -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.

```yaml

jobs:
list-issues:
runs-on: ubuntu-latest
Expand All @@ -225,7 +224,6 @@ jobs:
}
const result = await github.graphql(query, variables)
console.log(result)

```

### Run a separate file
Expand Down Expand Up @@ -268,3 +266,53 @@ external function.
Additionally, you'll want to use the [checkout
action](https://github.com/actions/checkout) to make sure your script file is
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 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)
```

### Use env as input

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

```yaml
on: push

jobs:
echo-input:
runs-on: ubuntu-latest
steps:
- uses: actions/github-script@v3
env:
FIRST_NAME: Mona
LAST_NAME: Octocat
with:
script: |
const { FIRST_NAME, LAST_NAME } = process.env

console.log(`Hello ${FIRST_NAME} ${LAST_NAME}`)
```