mirror of
https://github.com/actions/github-script.git
synced 2026-10-15 20:06:55 +00:00
Compare commits
140
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
211cb3fefb | ||
|
|
ca0eeffcf7 | ||
|
|
9b7ebbb458 | ||
|
|
74da5f706e | ||
|
|
e3cbab99d3 | ||
|
|
115b09eedf | ||
|
|
df46368761 | ||
|
|
faea5b2adf | ||
|
|
382585067c | ||
|
|
7b791155c1 | ||
|
|
f6f802415c | ||
|
|
0c6f007687 | ||
|
|
b3a068aede | ||
|
|
00e1b58cd9 | ||
|
|
c08c323075 | ||
|
|
9bb3853081 | ||
|
|
415189ab4b | ||
|
|
441359b1a3 | ||
|
|
4e1175c483 | ||
|
|
004e46f649 | ||
|
|
5e5d515dc7 | ||
|
|
deb7ae927c | ||
|
|
b6ebfda822 | ||
|
|
6a0bb322b7 | ||
|
|
5d31eecbde | ||
|
|
282dd6ab09 | ||
|
|
f891eff651 | ||
|
|
43434074d0 | ||
|
|
ab3c97fb6b | ||
|
|
e02270e59f | ||
|
|
c07f5aaf74 | ||
|
|
49d397a538 | ||
|
|
6f9b9a87b5 | ||
|
|
6456c11da2 | ||
|
|
a8325789f1 | ||
|
|
771c6ccbd2 | ||
|
|
854d2138dc | ||
|
|
f9d46abb2a | ||
|
|
aaceb2cf67 | ||
|
|
5ed343d94b | ||
|
|
a7abfdfa4d | ||
|
|
4294354415 | ||
|
|
ecb772f447 | ||
|
|
5fa6e37385 | ||
|
|
936c9d9f72 | ||
|
|
672319273b | ||
|
|
7c21e3730f | ||
|
|
787406b248 | ||
|
|
bfb7c2383c | ||
|
|
c32ce148a6 | ||
|
|
cec08706ee | ||
|
|
a3e7071a34 | ||
|
|
3858e71d11 | ||
|
|
2b34a689ec | ||
|
|
85e88a66ea | ||
|
|
5cbb702e24 | ||
|
|
1ef7fd09ca | ||
|
|
a49bf6b2cd | ||
|
|
95fb649573 | ||
|
|
2923e50f29 | ||
|
|
b616178d6d | ||
|
|
c758586ea1 | ||
|
|
256da4ea4d | ||
|
|
5ee517dae8 | ||
|
|
fb7e8f7c67 | ||
|
|
4a93ad9f9e | ||
|
|
19e7914023 | ||
|
|
3ede58996d | ||
|
|
01f87b6c01 | ||
|
|
b0e12e725b | ||
|
|
7e12bd7395 | ||
|
|
7e8659dcd4 | ||
|
|
d37f92ff11 | ||
|
|
1f8fc98741 | ||
|
|
f57c84a8e8 | ||
|
|
ade5cea985 | ||
|
|
c1c139b0ab | ||
|
|
3ca4cd5a00 | ||
|
|
83c92d6511 | ||
|
|
c416f56b51 | ||
|
|
75e3a5b35d | ||
|
|
e853490b13 | ||
|
|
f4e5d39c2a | ||
|
|
ddba1b195d | ||
|
|
59cb74c2ee | ||
|
|
5467f2a1ed | ||
|
|
c72dc00003 | ||
|
|
f05a81df23 | ||
|
|
74ae80c200 | ||
|
|
7488ca4f39 | ||
|
|
8920b9a6ed | ||
|
|
8685086334 | ||
|
|
01dfe2e0c1 | ||
|
|
934655b9e0 | ||
|
|
a56d4504de | ||
|
|
bb407510e7 | ||
|
|
3673bc4c4f | ||
|
|
3d069b2f0c | ||
|
|
77c8747753 | ||
|
|
e86864dfd7 | ||
|
|
58e7e1dbfa | ||
|
|
b251c3e139 | ||
|
|
5b5c43cb7b | ||
|
|
74776b4afc | ||
|
|
01904b97ff | ||
|
|
315fb4f388 | ||
|
|
5c9e354ff0 | ||
|
|
2f21207c8d | ||
|
|
1318dc37ba | ||
|
|
f4f25ebaab | ||
|
|
b91d578158 | ||
|
|
a52e7f4cf4 | ||
|
|
b714c526d7 | ||
|
|
96374ece58 | ||
|
|
47f7cf65b5 | ||
|
|
58579a2cbf | ||
|
|
8c2abf1707 | ||
|
|
ed05d35c66 | ||
|
|
bc192ff403 | ||
|
|
5c195044a2 | ||
|
|
bdd2dafb12 | ||
|
|
2d40ba5c82 | ||
|
|
3c58ce3675 | ||
|
|
ff0a9e81a8 | ||
|
|
9d620e45a4 | ||
|
|
e5156a8b84 | ||
|
|
b780942434 | ||
|
|
f035cea467 | ||
|
|
6bd37e1a50 | ||
|
|
9124ee04c3 | ||
|
|
28e5ebafd7 | ||
|
|
ce5d26b1ab | ||
|
|
91121b9cb3 | ||
|
|
ac77fc9f3f | ||
|
|
eb58336601 | ||
|
|
af3c0bbd72 | ||
|
|
fdf4916d13 | ||
|
|
89e42e73d1 | ||
|
|
e2ddba4dfc | ||
|
|
cf1dcb0bd5 |
No files matched your search
@@ -0,0 +1,52 @@
|
|||||||
|
# `dist/index.js` is a special file in Actions.
|
||||||
|
# When you reference an action with `uses:` in a workflow,
|
||||||
|
# `index.js` is the code that will run.
|
||||||
|
# For our project, we generate this file through a build process
|
||||||
|
# from other source files.
|
||||||
|
# We need to make sure the checked-in `index.js` actually matches what we expect it to be.
|
||||||
|
name: Check dist/
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
paths-ignore:
|
||||||
|
- '**.md'
|
||||||
|
pull_request:
|
||||||
|
paths-ignore:
|
||||||
|
- '**.md'
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
check-dist:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Set Node.js 12.x
|
||||||
|
uses: actions/setup-node@v1
|
||||||
|
with:
|
||||||
|
node-version: 12.x
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Rebuild the dist/ directory
|
||||||
|
run: npm run build
|
||||||
|
|
||||||
|
- name: Compare the expected and actual dist/ directories
|
||||||
|
run: |
|
||||||
|
if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
|
||||||
|
echo "Detected uncommitted changes after build. See status below:"
|
||||||
|
git diff
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
id: diff
|
||||||
|
|
||||||
|
# If index.js was different than expected, upload the expected version as an artifact
|
||||||
|
- uses: actions/upload-artifact@v2
|
||||||
|
if: ${{ failure() && steps.diff.conclusion == 'failure' }}
|
||||||
|
with:
|
||||||
|
name: dist
|
||||||
|
path: dist/
|
||||||
@@ -1,19 +1,20 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push: {branches: main}
|
push:
|
||||||
pull_request: {branches: main}
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
ci:
|
ci:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/setup-node@v1
|
- uses: actions/setup-node@v2
|
||||||
with: {node-version: 13.x}
|
|
||||||
- uses: actions/cache@v1
|
|
||||||
with:
|
with:
|
||||||
path: ~/.npm
|
node-version: 12
|
||||||
key: ${{runner.os}}-npm-${{hashFiles('**/package-lock.json')}}
|
cache: npm
|
||||||
restore-keys: ${{runner.os}}-npm-
|
|
||||||
- run: npm ci
|
- run: npm ci
|
||||||
- run: npm run style:check
|
- run: npm run style:check
|
||||||
- run: npm test
|
- run: npm test
|
||||||
@@ -1,12 +1,18 @@
|
|||||||
|
name: Integration
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push: {branches: main}
|
push:
|
||||||
|
branches: [main]
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
integration:
|
test-return:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
- id: output-set
|
- id: output-set
|
||||||
uses: actions/github-script@main
|
uses: ./
|
||||||
with:
|
with:
|
||||||
script: return core.getInput('input-value')
|
script: return core.getInput('input-value')
|
||||||
result-encoding: string
|
result-encoding: string
|
||||||
@@ -15,3 +21,39 @@ jobs:
|
|||||||
if [[ "${{steps.output-set.outputs.result}}" != "output" ]]; then
|
if [[ "${{steps.output-set.outputs.result}}" != "output" ]]; then
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
test-relative-require:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- id: output-set
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
script: return require('./package.json').name
|
||||||
|
result-encoding: string
|
||||||
|
input-value: output
|
||||||
|
- run: |
|
||||||
|
if [[ "${{steps.output-set.outputs.result}}" != "github-script" ]]; then
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
test-npm-require:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- uses: actions/cache@v2
|
||||||
|
with:
|
||||||
|
path: ~/.npm
|
||||||
|
key: ${{runner.os}}-npm-${{hashFiles('**/package-lock.json')}}
|
||||||
|
restore-keys: ${{runner.os}}-npm-
|
||||||
|
- run: npm ci
|
||||||
|
- id: output-set
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
script: return require('@actions/core/package.json').name
|
||||||
|
result-encoding: string
|
||||||
|
input-value: output
|
||||||
|
- run: |
|
||||||
|
if [[ "${{steps.output-set.outputs.result}}" != "@actions/core" ]]; then
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
@@ -1,10 +1,12 @@
|
|||||||
name: Licensed
|
name: Licensed
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push: {branches: main}
|
push:
|
||||||
pull_request: {branches: main}
|
branches:
|
||||||
repository_dispatch:
|
- main
|
||||||
workflow_dispatch:
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
test:
|
||||||
@@ -12,16 +14,11 @@ jobs:
|
|||||||
name: Check licenses
|
name: Check licenses
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/cache@v1
|
|
||||||
with:
|
with:
|
||||||
path: ~/.npm
|
fetch-depth: 0 # prefer to use a full fetch for licensed workflows
|
||||||
key: ${{runner.os}}-npm-${{hashFiles('**/package-lock.json')}}
|
# https://github.com/jonabc/setup-licensed/releases/tag/v1.1.1
|
||||||
restore-keys: ${{runner.os}}-npm-
|
- uses: jonabc/setup-licensed@82c5f4d19e8968efa74a25b132922382c2671fe2
|
||||||
|
with:
|
||||||
|
version: '3.x'
|
||||||
- run: npm ci
|
- run: npm ci
|
||||||
- name: Install licensed
|
|
||||||
run: |-
|
|
||||||
cd $RUNNER_TEMP
|
|
||||||
curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/2.9.2/licensed-2.9.2-linux-x64.tar.gz
|
|
||||||
sudo tar -xzf licensed.tar.gz
|
|
||||||
sudo mv licensed /usr/local/bin/licensed
|
|
||||||
- run: licensed status
|
- run: licensed status
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
|
name: Pull Request Test
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: main
|
branches: [main]
|
||||||
types: [opened, synchronize]
|
types: [opened, synchronize]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
@@ -12,7 +14,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
script: |
|
script: |
|
||||||
// Get the existing comments.
|
// Get the existing comments.
|
||||||
const {data: comments} = await github.issues.listComments({
|
const {data: comments} = await github.rest.issues.listComments({
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
issue_number: context.payload.number,
|
issue_number: context.payload.number,
|
||||||
@@ -22,18 +24,22 @@ jobs:
|
|||||||
const botComment = comments.find(comment => comment.user.id === 41898282)
|
const botComment = comments.find(comment => comment.user.id === 41898282)
|
||||||
const commentBody = "Hello from actions/github-script! (${{ github.sha }})"
|
const commentBody = "Hello from actions/github-script! (${{ github.sha }})"
|
||||||
|
|
||||||
if (botComment) {
|
if (context.payload.pull_request.head.repo.full_name !== 'actions/github-script') {
|
||||||
await github.issues.updateComment({
|
console.log('Not attempting to write comment on PR from fork');
|
||||||
owner: context.repo.owner,
|
|
||||||
repo: context.repo.repo,
|
|
||||||
comment_id: botComment.id,
|
|
||||||
body: commentBody
|
|
||||||
})
|
|
||||||
} else {
|
} else {
|
||||||
await github.issues.createComment({
|
if (botComment) {
|
||||||
owner: context.repo.owner,
|
await github.rest.issues.updateComment({
|
||||||
repo: context.repo.repo,
|
owner: context.repo.owner,
|
||||||
issue_number: context.payload.number,
|
repo: context.repo.repo,
|
||||||
body: commentBody
|
comment_id: botComment.id,
|
||||||
})
|
body: commentBody
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
await github.rest.issues.createComment({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
issue_number: context.payload.number,
|
||||||
|
body: commentBody
|
||||||
|
})
|
||||||
|
}
|
||||||
}
|
}
|
||||||
Executable
+4
@@ -0,0 +1,4 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
. "$(dirname "$0")/_/husky.sh"
|
||||||
|
|
||||||
|
npm run pre-commit && git add dist/
|
||||||
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
Binary file not shown.
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
Generated
BIN
Binary file not shown.
@@ -0,0 +1 @@
|
|||||||
|
* @actions/actions-experience
|
||||||
@@ -1,4 +1,8 @@
|
|||||||
# github-script   
|
# actions/github-script
|
||||||
|
|
||||||
|
[](https://github.com/actions/github-script/actions?query=workflow%3AIntegration+branch%3Amain+event%3Apush)
|
||||||
|
[](https://github.com/actions/github-script/actions?query=workflow%3ACI+branch%3Amain+event%3Apush)
|
||||||
|
[](https://github.com/actions/github-script/actions?query=workflow%3ALicensed+branch%3Amain+event%3Apush)
|
||||||
|
|
||||||
This action makes it easy to quickly write a script in your workflow that
|
This action makes it easy to quickly write a script in your workflow that
|
||||||
uses the GitHub API and the workflow run context.
|
uses the GitHub API and the workflow run context.
|
||||||
@@ -8,20 +12,33 @@ input should be the body of an asynchronous function call. The following
|
|||||||
arguments will be provided:
|
arguments will be provided:
|
||||||
|
|
||||||
- `github` A pre-authenticated
|
- `github` A pre-authenticated
|
||||||
[octokit/rest.js](https://github.com/octokit/rest.js) client
|
[octokit/rest.js](https://octokit.github.io/rest.js) client with pagination plugins
|
||||||
- `context` An object containing the [context of the workflow
|
- `context` An object containing the [context of the workflow
|
||||||
run](https://github.com/actions/toolkit/blob/main/packages/github/src/context.ts)
|
run](https://github.com/actions/toolkit/blob/main/packages/github/src/context.ts)
|
||||||
- `core` A reference to the [@actions/core](https://github.com/actions/toolkit/tree/main/packages/core) package
|
- `core` A reference to the [@actions/core](https://github.com/actions/toolkit/tree/main/packages/core) package
|
||||||
|
- `glob` A reference to the [@actions/glob](https://github.com/actions/toolkit/tree/main/packages/glob) package
|
||||||
- `io` A reference to the [@actions/io](https://github.com/actions/toolkit/tree/main/packages/io) package
|
- `io` A reference to the [@actions/io](https://github.com/actions/toolkit/tree/main/packages/io) package
|
||||||
|
- `exec` A reference to the [@actions/exec](https://github.com/actions/toolkit/tree/main/packages/exec) package
|
||||||
|
- `require` A proxy wrapper around the normal Node.js `require` to enable
|
||||||
|
requiring relative paths (relative to the current working directory) and
|
||||||
|
requiring npm packages installed in the current working directory. If for
|
||||||
|
some reason you need the non-wrapped `require`, there is an escape hatch
|
||||||
|
available: `__original_require__` is the original value of `require` without
|
||||||
|
our wrapping applied.
|
||||||
|
|
||||||
Since the `script` is just a function body, these values will already be
|
Since the `script` is just a function body, these values will already be
|
||||||
defined, so you don't have to (see examples below).
|
defined, so you don't have to import them (see examples below).
|
||||||
|
|
||||||
See [octokit/rest.js](https://octokit.github.io/rest.js/) for the API client
|
See [octokit/rest.js](https://octokit.github.io/rest.js/) for the API client
|
||||||
documentation.
|
documentation.
|
||||||
|
|
||||||
**Note** This action is still a bit of an experiment—the API may change in
|
## Breaking changes in V5
|
||||||
future versions. 🙂
|
|
||||||
|
Version 5 of this action includes the version 5 of `@actions/github` and `@octokit/plugin-rest-endpoint-methods`. As part of this update, the Octokit context available via `github` no longer has REST methods directly. These methods are available via `github.rest.*` - https://github.com/octokit/plugin-rest-endpoint-methods.js/releases/tag/v5.0.0
|
||||||
|
|
||||||
|
For example, `github.issues.createComment` in V4 becomes `github.rest.issues.createComment` in V5
|
||||||
|
|
||||||
|
`github.request`, `github.paginate`, and `github.graphql` are unchanged.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
@@ -33,7 +50,7 @@ The return value of the script will be in the step's outputs under the
|
|||||||
"result" key.
|
"result" key.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/github-script@v3
|
- uses: actions/github-script@v5
|
||||||
id: set-result
|
id: set-result
|
||||||
with:
|
with:
|
||||||
script: return "Hello!"
|
script: return "Hello!"
|
||||||
@@ -52,10 +69,9 @@ output of a github-script step. For some workflows, string encoding is preferred
|
|||||||
`result-encoding` input:
|
`result-encoding` input:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/github-script@v3
|
- uses: actions/github-script@v5
|
||||||
id: my-script
|
id: my-script
|
||||||
with:
|
with:
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
|
||||||
result-encoding: string
|
result-encoding: string
|
||||||
script: return "I will be string (not JSON) encoded!"
|
script: return "I will be string (not JSON) encoded!"
|
||||||
```
|
```
|
||||||
@@ -67,6 +83,15 @@ 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
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: View context attributes
|
||||||
|
uses: actions/github-script@v5
|
||||||
|
with:
|
||||||
|
script: console.log(context)
|
||||||
|
```
|
||||||
|
|
||||||
### Comment on an issue
|
### Comment on an issue
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@@ -78,11 +103,10 @@ jobs:
|
|||||||
comment:
|
comment:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/github-script@v3
|
- uses: actions/github-script@v5
|
||||||
with:
|
with:
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
|
||||||
script: |
|
script: |
|
||||||
github.issues.createComment({
|
github.rest.issues.createComment({
|
||||||
issue_number: context.issue.number,
|
issue_number: context.issue.number,
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
@@ -101,11 +125,10 @@ jobs:
|
|||||||
apply-label:
|
apply-label:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/github-script@v3
|
- uses: actions/github-script@v5
|
||||||
with:
|
with:
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
|
||||||
script: |
|
script: |
|
||||||
github.issues.addLabels({
|
github.rest.issues.addLabels({
|
||||||
issue_number: context.issue.number,
|
issue_number: context.issue.number,
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
@@ -122,14 +145,13 @@ jobs:
|
|||||||
welcome:
|
welcome:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/github-script@v3
|
- uses: actions/github-script@v5
|
||||||
with:
|
with:
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
|
||||||
script: |
|
script: |
|
||||||
// Get a list of all issues created by the PR opener
|
// Get a list of all issues created by the PR opener
|
||||||
// See: https://octokit.github.io/rest.js/#pagination
|
// See: https://octokit.github.io/rest.js/#pagination
|
||||||
const creator = context.payload.sender.login
|
const creator = context.payload.sender.login
|
||||||
const opts = github.issues.listForRepo.endpoint.merge({
|
const opts = github.rest.issues.listForRepo.endpoint.merge({
|
||||||
...context.issue,
|
...context.issue,
|
||||||
creator,
|
creator,
|
||||||
state: 'all'
|
state: 'all'
|
||||||
@@ -146,7 +168,7 @@ jobs:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
await github.issues.createComment({
|
await github.rest.issues.createComment({
|
||||||
issue_number: context.issue.number,
|
issue_number: context.issue.number,
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
@@ -166,9 +188,8 @@ jobs:
|
|||||||
diff:
|
diff:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/github-script@v3
|
- uses: actions/github-script@v5
|
||||||
with:
|
with:
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
|
||||||
script: |
|
script: |
|
||||||
const diff_url = context.payload.pull_request.diff_url
|
const diff_url = context.payload.pull_request.diff_url
|
||||||
const result = await github.request(diff_url)
|
const result = await github.request(diff_url)
|
||||||
@@ -182,6 +203,36 @@ using the API.)_
|
|||||||
This will print the full diff object in the screen; `result.data` will
|
This will print the full diff object in the screen; `result.data` will
|
||||||
contain the actual diff text.
|
contain the actual diff text.
|
||||||
|
|
||||||
|
### Run custom GraphQL queries
|
||||||
|
|
||||||
|
You can use the `github.graphql` object to run custom GraphQL queries against the GitHub API.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
jobs:
|
||||||
|
list-issues:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/github-script@v5
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
const query = `query($owner:String!, $name:String!, $label:String!) {
|
||||||
|
repository(owner:$owner, name:$name){
|
||||||
|
issues(first:100, labels: [$label]) {
|
||||||
|
nodes {
|
||||||
|
id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}`;
|
||||||
|
const variables = {
|
||||||
|
owner: context.repo.owner,
|
||||||
|
name: context.repo.repo,
|
||||||
|
label: 'wontfix'
|
||||||
|
}
|
||||||
|
const result = await github.graphql(query, variables)
|
||||||
|
console.log(result)
|
||||||
|
```
|
||||||
|
|
||||||
### Run a separate file
|
### Run a separate file
|
||||||
|
|
||||||
If you don't want to inline your entire script that you want to run, you can
|
If you don't want to inline your entire script that you want to run, you can
|
||||||
@@ -195,26 +246,21 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
- uses: actions/github-script@v2
|
- uses: actions/github-script@v5
|
||||||
with:
|
with:
|
||||||
script: |
|
script: |
|
||||||
const script = require(`${process.env.GITHUB_WORKSPACE}/path/to/script.js`)
|
const script = require('./path/to/script.js')
|
||||||
console.log(script({github, context}))
|
console.log(script({github, context}))
|
||||||
```
|
```
|
||||||
|
|
||||||
*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:
|
And then export a function from your module:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
module.exports = (github, context) => {
|
module.exports = ({github, context}) => {
|
||||||
return context.payload.client_payload.value
|
return context.payload.client_payload.value
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also use async functions in this manner, as long as you `await` it in
|
|
||||||
the inline script.
|
|
||||||
|
|
||||||
Note that because you can't `require` things like the GitHub context or
|
Note that because you can't `require` things like the GitHub context or
|
||||||
Actions Toolkit libraries, you'll want to pass them as arguments to your
|
Actions Toolkit libraries, you'll want to pass them as arguments to your
|
||||||
external function.
|
external function.
|
||||||
@@ -223,98 +269,104 @@ 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.
|
||||||
|
|
||||||
|
### Run a separate file with an async function
|
||||||
|
|
||||||
This action makes it easy to quickly write a script in your workflow that
|
You can also use async functions in this manner, as long as you `await` it in
|
||||||
uses the GitHub API and the workflow run context.
|
the inline script.
|
||||||
|
|
||||||
In order to use this action, a `script` input is provided. The value of that
|
In your workflow:
|
||||||
input should be the body of an asynchronous function call. The following
|
|
||||||
arguments will be provided:
|
|
||||||
|
|
||||||
- `github` A pre-authenticated
|
|
||||||
[octokit/rest.js](https://github.com/octokit/rest.js) client
|
|
||||||
- `context` An object containing the [context of the workflow
|
|
||||||
run](https://github.com/actions/toolkit/blob/main/packages/github/src/context.ts)
|
|
||||||
- `core` A reference to the [@actions/core](https://github.com/actions/toolkit/tree/main/packages/core) package
|
|
||||||
- `io` A reference to the [@actions/io](https://github.com/actions/toolkit/tree/main/packages/io) package
|
|
||||||
|
|
||||||
Since the `script` is just a function body, these values will already be
|
|
||||||
defined, so you don't have to (see examples below).
|
|
||||||
|
|
||||||
See [octokit/rest.js](https://octokit.github.io/rest.js/) for the API client
|
|
||||||
documentation.
|
|
||||||
|
|
||||||
**Note** This action is still a bit of an experiment—the API may change in
|
|
||||||
future versions. 🙂
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
See [development.md](/docs/development.md).
|
|
||||||
|
|
||||||
## Reading step results
|
|
||||||
|
|
||||||
The return value of the script will be in the step's outputs under the
|
|
||||||
"result" key.
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/github-script@v3
|
on: push
|
||||||
id: set-result
|
|
||||||
with:
|
|
||||||
script: return "Hello!"
|
|
||||||
result-encoding: string
|
|
||||||
- name: Get result
|
|
||||||
run: echo "${{steps.set-result.outputs.result}}"
|
|
||||||
```
|
|
||||||
|
|
||||||
See ["Result encoding"](#result-encoding) for details on how the encoding of
|
|
||||||
these outputs can be changed.
|
|
||||||
|
|
||||||
## Result encoding
|
|
||||||
|
|
||||||
By default, the JSON-encoded return value of the function is set as the "result" in the
|
|
||||||
output of a github-script step. For some workflows, string encoding is preferred. This option can be set using the
|
|
||||||
`result-encoding` input:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- uses: actions/github-script@v3
|
|
||||||
id: my-script
|
|
||||||
with:
|
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
|
||||||
result-encoding: string
|
|
||||||
script: return "I will be string (not JSON) encoded!"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
Note that `github-token` is optional in this action, and the input is there
|
|
||||||
in case you need to use a non-default token.
|
|
||||||
|
|
||||||
By default, github-script will use the token provided to your workflow.
|
|
||||||
|
|
||||||
### Comment on an issue
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
on:
|
|
||||||
issues:
|
|
||||||
types: [opened]
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
comment:
|
echo-input:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/github-script@v3
|
- uses: actions/checkout@v2
|
||||||
|
- uses: actions/github-script@v5
|
||||||
|
env:
|
||||||
|
SHA: '${{env.parentSHA}}'
|
||||||
with:
|
with:
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
|
||||||
script: |
|
script: |
|
||||||
github.issues.createComment({
|
const script = require('./path/to/script.js')
|
||||||
issue_number: context.issue.number,
|
await script({github, context, core})
|
||||||
owner: context.repo.owner,
|
|
||||||
repo: context.repo.repo,
|
|
||||||
body: '👋 Thanks for reporting!'
|
|
||||||
})
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Apply a label to an issue
|
And then export an async function from your module:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
module.exports = async ({github, context, core}) => {
|
||||||
|
const {SHA} = process.env
|
||||||
|
const commit = await github.rest.repos.getCommit({
|
||||||
|
owner: context.repo.owner,
|
||||||
|
repo: context.repo.repo,
|
||||||
|
ref: `${SHA}`
|
||||||
|
})
|
||||||
|
core.exportVariable('author', commit.data.commit.author.email)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Use npm packages
|
||||||
|
|
||||||
|
Like importing your own files above, you can also use installed modules.
|
||||||
|
Note that this is achieved with a wrapper on top `require`, so if you're
|
||||||
|
trying to require a module inside your own file, you might need to import
|
||||||
|
it externally or pass the `require` wrapper to your file:
|
||||||
|
|
||||||
|
```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@v5
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
const execa = require('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@v5
|
||||||
|
env:
|
||||||
|
FIRST_NAME: Mona
|
||||||
|
LAST_NAME: Octocat
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
const { FIRST_NAME, LAST_NAME } = process.env
|
||||||
|
|
||||||
|
console.log(`Hello ${FIRST_NAME} ${LAST_NAME}`)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using a separate GitHub token
|
||||||
|
|
||||||
|
The `GITHUB_TOKEN` used by default is scoped to the current repository, see [Authentication in a workflow](https://docs.github.com/actions/reference/authentication-in-a-workflow).
|
||||||
|
|
||||||
|
If you need access to a different repository or an API that the `GITHUB_TOKEN` doesn't have permissions to, you can provide your own [PAT](https://help.github.com/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) as a secret using the `github-token` input.
|
||||||
|
|
||||||
|
[Learn more about creating and using encrypted secrets](https://docs.github.com/actions/reference/encrypted-secrets)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
on:
|
on:
|
||||||
@@ -325,124 +377,14 @@ jobs:
|
|||||||
apply-label:
|
apply-label:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/github-script@v3
|
- uses: actions/github-script@v5
|
||||||
with:
|
with:
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
github-token: ${{ secrets.MY_PAT }}
|
||||||
script: |
|
script: |
|
||||||
github.issues.addLabels({
|
github.rest.issues.addLabels({
|
||||||
issue_number: context.issue.number,
|
issue_number: context.issue.number,
|
||||||
owner: context.repo.owner,
|
owner: context.repo.owner,
|
||||||
repo: context.repo.repo,
|
repo: context.repo.repo,
|
||||||
labels: ['Triage']
|
labels: ['Triage']
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
### Welcome a first-time contributor
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
on: pull_request
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
welcome:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/github-script@v3
|
|
||||||
with:
|
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
|
||||||
script: |
|
|
||||||
// Get a list of all issues created by the PR opener
|
|
||||||
// See: https://octokit.github.io/rest.js/#pagination
|
|
||||||
const creator = context.payload.sender.login
|
|
||||||
const opts = github.issues.listForRepo.endpoint.merge({
|
|
||||||
...context.issue,
|
|
||||||
creator,
|
|
||||||
state: 'all'
|
|
||||||
})
|
|
||||||
const issues = await github.paginate(opts)
|
|
||||||
|
|
||||||
for (const issue of issues) {
|
|
||||||
if (issue.number === context.issue.number) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if (issue.pull_request) {
|
|
||||||
return // Creator is already a contributor.
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
await github.issues.createComment({
|
|
||||||
issue_number: context.issue.number,
|
|
||||||
owner: context.repo.owner,
|
|
||||||
repo: context.repo.repo,
|
|
||||||
body: 'Welcome, new contributor!'
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
### Download data from a URL
|
|
||||||
|
|
||||||
You can use the `github` object to access the Octokit API. For
|
|
||||||
instance, `github.request`
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
on: pull_request
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
diff:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/github-script@v3
|
|
||||||
with:
|
|
||||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
|
||||||
script: |
|
|
||||||
const diff_url = context.payload.pull_request.diff_url
|
|
||||||
const result = await github.request(diff_url)
|
|
||||||
console.log(result)
|
|
||||||
```
|
|
||||||
|
|
||||||
_(Note that this particular example only works for a public URL, where the
|
|
||||||
diff URL is publicly accessible. Getting the diff for a private URL requires
|
|
||||||
using the API.)_
|
|
||||||
|
|
||||||
This will print the full diff object in the screen; `result.data` will
|
|
||||||
contain the actual diff text.
|
|
||||||
|
|
||||||
### Run a separate file
|
|
||||||
|
|
||||||
If you don't want to inline your entire script that you want to run, you can
|
|
||||||
use a separate JavaScript module in your repository like so:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
on: push
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
echo-input:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v2
|
|
||||||
- uses: actions/github-script@v2
|
|
||||||
with:
|
|
||||||
script: |
|
|
||||||
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 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 = (github, context) => {
|
|
||||||
return context.payload.client_payload.value
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also use async functions in this manner, as long as you `await` it in
|
|
||||||
the inline script.
|
|
||||||
|
|
||||||
Note that because you can't `require` things like the GitHub context or
|
|
||||||
Actions Toolkit libraries, you'll want to pass them as arguments to your
|
|
||||||
external function.
|
|
||||||
|
|
||||||
Additionally, you'll want to use the [checkout
|
|
||||||
action](https://github.com/actions/checkout) to make sure your script file is
|
|
||||||
available.
|
|
||||||
Vendored
+8552
-1037
File diff suppressed because it is too large.
Load diff
+3
-3
@@ -22,7 +22,7 @@ well.
|
|||||||
|
|
||||||
Releases are done manually, for now:
|
Releases are done manually, for now:
|
||||||
|
|
||||||
1. Ensure that the build is up to date with `npm run build`.
|
1. Ensure that the build is up to date with `npm run build`. It's also good to ensure you have the correct dependencies installed by running `npm install` before you build.
|
||||||
1. Bump the [package.json](/package.json#L3) and [package-lock.json](/package-lock.json#L3) version numbers and commit them.
|
1. Bump the [package.json](/package.json#L3) and [package-lock.json](/package-lock.json#L3) version numbers and commit them. I like to do this with `npm version {major,minor,patch} --no-git-tag-version`. This will bump the version numbers but let you manually commit and tag, yourself.
|
||||||
1. Update documentation (including updated version numbers).
|
1. Update documentation (including updated version numbers).
|
||||||
1. Tag main with the new version number and create a GitHub release.
|
1. Tag main with the new version number and create a GitHub release. Make sure you also force-create and force-push tags for minor and patch updates. For example, when creating v5.2.0 (a minor bump), you want to create (or update) `v5`, `v5.2`, and `v5.2.0`.
|
||||||
Generated
+8187
-4795
File diff suppressed because it is too large.
Load diff
+20
-22
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "github-script",
|
"name": "github-script",
|
||||||
"description": "A GitHub action for executing a simple script",
|
"description": "A GitHub action for executing a simple script",
|
||||||
"version": "3.0.0",
|
"version": "5.2.0",
|
||||||
"author": "GitHub",
|
"author": "GitHub",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
@@ -14,12 +14,8 @@
|
|||||||
"style:check": "run-p --continue-on-error --aggregate-output format:check lint",
|
"style:check": "run-p --continue-on-error --aggregate-output format:check lint",
|
||||||
"style:write": "run-p --continue-on-error --aggregate-output format:write lint",
|
"style:write": "run-p --continue-on-error --aggregate-output format:write lint",
|
||||||
"pre-commit": "run-s style:write test build",
|
"pre-commit": "run-s style:write test build",
|
||||||
"test": "jest"
|
"test": "jest",
|
||||||
},
|
"prepare": "husky install"
|
||||||
"husky": {
|
|
||||||
"hooks": {
|
|
||||||
"pre-commit": "npm run pre-commit && git add dist/"
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
"jest": {
|
"jest": {
|
||||||
"preset": "ts-jest",
|
"preset": "ts-jest",
|
||||||
@@ -35,25 +31,27 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": "^1.2.4",
|
"@actions/core": "^1.10.0",
|
||||||
"@actions/github": "^4.0.0",
|
"@actions/exec": "^1.1.0",
|
||||||
"@actions/io": "^1.0.2",
|
"@actions/github": "^5.0.0",
|
||||||
"@octokit/core": "^3.1.2",
|
"@actions/glob": "^0.2.0",
|
||||||
"@octokit/plugin-paginate-rest": "^2.3.0",
|
"@actions/io": "^1.1.1",
|
||||||
"@octokit/plugin-rest-endpoint-methods": "^4.1.2"
|
"@octokit/core": "^3.5.1",
|
||||||
|
"@octokit/plugin-paginate-rest": "^2.17.0",
|
||||||
|
"@octokit/plugin-rest-endpoint-methods": "^5.13.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/jest": "^26.0.10",
|
"@types/jest": "^27.0.2",
|
||||||
"@typescript-eslint/eslint-plugin": "^3.9.1",
|
"@typescript-eslint/eslint-plugin": "^3.10.1",
|
||||||
"@typescript-eslint/parser": "^3.9.1",
|
"@typescript-eslint/parser": "^3.10.1",
|
||||||
"@vercel/ncc": "^0.23.0",
|
"@vercel/ncc": "^0.23.0",
|
||||||
"eslint": "^7.7.0",
|
"eslint": "^7.32.0",
|
||||||
"eslint-config-prettier": "^6.11.0",
|
"eslint-config-prettier": "^6.15.0",
|
||||||
"husky": "^4.2.5",
|
"husky": "^7.0.0",
|
||||||
"jest": "^26.4.1",
|
"jest": "^27.2.5",
|
||||||
"npm-run-all": "^4.1.5",
|
"npm-run-all": "^4.1.5",
|
||||||
"prettier": "^2.0.5",
|
"prettier": "^2.0.5",
|
||||||
"ts-jest": "^26.2.0",
|
"ts-jest": "^27.0.5",
|
||||||
"typescript": "^4.0.2"
|
"typescript": "^4.3.5"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
import * as core from '@actions/core'
|
import * as core from '@actions/core'
|
||||||
|
import * as exec from '@actions/exec'
|
||||||
import {Context} from '@actions/github/lib/context'
|
import {Context} from '@actions/github/lib/context'
|
||||||
import {GitHub} from '@actions/github/lib/utils'
|
import {GitHub} from '@actions/github/lib/utils'
|
||||||
|
import * as glob from '@actions/glob'
|
||||||
import * as io from '@actions/io'
|
import * as io from '@actions/io'
|
||||||
|
|
||||||
const AsyncFunction = Object.getPrototypeOf(async () => null).constructor
|
const AsyncFunction = Object.getPrototypeOf(async () => null).constructor
|
||||||
@@ -9,8 +11,11 @@ type AsyncFunctionArguments = {
|
|||||||
context: Context
|
context: Context
|
||||||
core: typeof core
|
core: typeof core
|
||||||
github: InstanceType<typeof GitHub>
|
github: InstanceType<typeof GitHub>
|
||||||
|
exec: typeof exec
|
||||||
|
glob: typeof glob
|
||||||
io: typeof io
|
io: typeof io
|
||||||
require: NodeRequire
|
require: NodeRequire
|
||||||
|
__original_require__: NodeRequire
|
||||||
}
|
}
|
||||||
|
|
||||||
export function callAsyncFunction<T>(
|
export function callAsyncFunction<T>(
|
||||||
|
|||||||
+13
-1
@@ -1,7 +1,10 @@
|
|||||||
import * as core from '@actions/core'
|
import * as core from '@actions/core'
|
||||||
|
import * as exec from '@actions/exec'
|
||||||
import {context, getOctokit} from '@actions/github'
|
import {context, getOctokit} from '@actions/github'
|
||||||
|
import * as glob from '@actions/glob'
|
||||||
import * as io from '@actions/io'
|
import * as io from '@actions/io'
|
||||||
import {callAsyncFunction} from './async-function'
|
import {callAsyncFunction} from './async-function'
|
||||||
|
import {wrapRequire} from './wrap-require'
|
||||||
|
|
||||||
process.on('unhandledRejection', handleError)
|
process.on('unhandledRejection', handleError)
|
||||||
main().catch(handleError)
|
main().catch(handleError)
|
||||||
@@ -28,7 +31,16 @@ async function main(): Promise<void> {
|
|||||||
|
|
||||||
// Using property/value shorthand on `require` (e.g. `{require}`) causes compilation errors.
|
// Using property/value shorthand on `require` (e.g. `{require}`) causes compilation errors.
|
||||||
const result = await callAsyncFunction(
|
const result = await callAsyncFunction(
|
||||||
{require: require, github, context, core, io},
|
{
|
||||||
|
require: wrapRequire,
|
||||||
|
__original_require__: __non_webpack_require__,
|
||||||
|
github,
|
||||||
|
context,
|
||||||
|
core,
|
||||||
|
exec,
|
||||||
|
glob,
|
||||||
|
io
|
||||||
|
},
|
||||||
script
|
script
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,25 @@
|
|||||||
|
import * as path from 'path'
|
||||||
|
|
||||||
|
export const wrapRequire = new Proxy(__non_webpack_require__, {
|
||||||
|
apply: (target, thisArg, [moduleID]) => {
|
||||||
|
if (moduleID.startsWith('.')) {
|
||||||
|
moduleID = path.resolve(moduleID)
|
||||||
|
return target.apply(thisArg, [moduleID])
|
||||||
|
}
|
||||||
|
|
||||||
|
const modulePath = target.resolve.apply(thisArg, [
|
||||||
|
moduleID,
|
||||||
|
{
|
||||||
|
// Webpack does not have an escape hatch for getting the actual
|
||||||
|
// module, other than `eval`.
|
||||||
|
paths: [process.cwd()]
|
||||||
|
}
|
||||||
|
])
|
||||||
|
|
||||||
|
return target.apply(thisArg, [modulePath])
|
||||||
|
},
|
||||||
|
|
||||||
|
get: (target, prop, receiver) => {
|
||||||
|
Reflect.get(target, prop, receiver)
|
||||||
|
}
|
||||||
|
})
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
declare const __non_webpack_require__: NodeRequire
|
||||||
Reference in new issue
Block a user