mirror of
https://github.com/actions/github-script.git
synced 2026-02-08 03:57:27 +00:00
d3f9a3b3fb
Both of the .cts and .mts flavors. Because this action is written in CommonJS both have to compile to CommonJS in order to execute. As it is TypeScript there's already an expectation of some slowness, so I went with the approach of running the script via the node VM module. While a cleaner approach, it has the caveat that root level await in the script doesn't work. That should become available if https://github.com/actions/github-script/issues/457 is completed.
43 lines
1.7 KiB
YAML
43 lines
1.7 KiB
YAML
name: GitHub Script
|
|
author: GitHub
|
|
description: Run simple scripts using the GitHub client
|
|
branding:
|
|
color: blue
|
|
icon: code
|
|
inputs:
|
|
script:
|
|
description: The script to run
|
|
required: true
|
|
github-token:
|
|
description: The GitHub token used to create an authenticated client
|
|
default: ${{ github.token }}
|
|
required: false
|
|
debug:
|
|
description: Whether to tell the GitHub client to log details of its requests. true or false. Default is to run in debug mode when the GitHub Actions step debug logging is turned on.
|
|
default: ${{ runner.debug == '1' }}
|
|
user-agent:
|
|
description: An optional user-agent string
|
|
default: actions/github-script
|
|
previews:
|
|
description: A comma-separated list of GraphQL API previews to accept
|
|
result-encoding:
|
|
description: Either "string" or "json" (default "json")—how the result will be encoded
|
|
default: json
|
|
retries:
|
|
description: The number of times to retry a request
|
|
default: "0"
|
|
retry-exempt-status-codes:
|
|
description: A comma separated list of status codes that will NOT be retried e.g. "400,500". No effect unless `retries` is set
|
|
default: 400,401,403,404,422 # from https://github.com/octokit/plugin-retry.js/blob/9a2443746c350b3beedec35cf26e197ea318a261/src/index.ts#L14
|
|
base-url:
|
|
description: An optional GitHub REST API URL to connect to a different GitHub instance. For example, https://my.github-enterprise-server.com/api/v3
|
|
required: false
|
|
language:
|
|
description: The language to interpret the script as. Pick from "cjs", "cts", "mts".
|
|
default: "cjs"
|
|
outputs:
|
|
result:
|
|
description: The return value of the script, stringified with `JSON.stringify`
|
|
runs:
|
|
using: node20
|
|
main: dist/index.js
|