Download
This action makes it easy to quickly write a script in your workflow that uses the GitHub API and the workflow run context. To use this action, provide an input named script that contains the body of an asynchronous function call. Since the script is just a function body, these values will already be defined, so you don't have to import them. All scripts are now run with Node 16 instead of Node 12 and are affected by any breaking changes between Node 12 and 16. 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. By default, requests made with the github instance will not be retried. You can configure this with the retries option.
Features
- Pre-authenticated octokit/rest.js client with pagination plugins
- Since the script is just a function body, these values will already be defined
- The return value of the script will be in the step's outputs
- 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
- Provides examples
Project Samples
