actions/github-script
Github Script
github-script is a GitHub Actions JavaScript runner that executes asynchronous scripts to interact with the GitHub API. It serves as a JavaScript workflow scripting runtime and API client, providing a pre-configured authenticated client for automating tasks within GitHub Actions pipelines.
The project enables the implementation of custom workflow logic that exceeds standard YAML syntax, including the ability to perform REST API calls and execute GraphQL queries for complex data extraction. It supports the management of multiple authenticated clients to facilitate cross-organization repository management.
The tool can export script results as JSON or string values for use in subsequent workflow steps. It also supports executing shell commands and integrating external modules to organize complex logic.
Features
- Workflow Logic - Implements complex conditional logic and data processing in workflows that exceed standard YAML syntax.
- CI/CD Scripting Runtimes - Provides a JavaScript runtime for executing asynchronous scripts and custom logic directly within GitHub Actions pipelines.
- GitHub API Client Wrappers - Wraps a standard API client to handle authentication, pagination, and retries for GitHub service interactions.
- GitHub API Integrations - Automates repetitive tasks within a repository using JavaScript to interact with the GitHub API.
- GraphQL API Clients - Executes custom GraphQL queries against the GitHub API to retrieve complex or nested data structures.
- GitHub API Clients - Retrieves deeply nested or complex data from GitHub using GraphQL queries within CI pipelines.
- REST API Clients - Provides a client to interact with remote REST services with built-in support for pagination and retries.
- Configuration-Driven Authentication - Injects secret tokens from the environment into API clients to manage identity and access permissions.
- External Script Execution - Runs custom JavaScript logic within a workflow to interact with external services using pre-configured tools.
- Runtime Script Injection - Executes dynamically provided JavaScript code within a pre-configured environment with global helper objects.
- GitHub Actions - Provides a JavaScript runtime for GitHub Actions that executes code using a pre-configured authenticated client.
- Asynchronous Script Workflows - Runs asynchronous code to interact with remote services using authenticated clients and shared context.
- Dynamic Module Loading - Allows scripts to resolve and import external JavaScript files or packages at runtime to extend logic.
- Multi-Organization Managers - Manages multiple repositories across different GitHub organizations using authenticated clients and custom scripts.
- JSON Output Formats - Exports script results as JSON or string values for programmatic consumption by subsequent workflow steps.
- Shell Command Execution - Runs system shell commands and captures resulting output and error streams for use in scripts.
- Workflow Output Writers - Generates custom JSON or string values from scripts to pass data between workflow steps.
- External Module Imports - Loads custom script files or installed packages to organize and reuse complex logic.
- JSON Serialization - Transforms script return values into stringified JSON objects for use in subsequent workflow steps.
- API Client Authentications - Creates multiple authenticated clients using different tokens to support cross-organization repository access.
- Script Value Exports - Exports function outputs as JSON or string values for use by subsequent workflow steps.
- Core Workflow Actions - Write a script for GitHub API and the workflow contexts.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
