actions/toolkit
Toolkit
The GitHub ToolKit for developing GitHub Actions.
Features
- GitHub Actions - Provides the official JavaScript toolkit for building custom GitHub Actions with API calls, file operations, and workflow integration.
- SDKs - Provides the official JavaScript SDK for building custom GitHub Actions.
- Programmatic File Operations - Creates, reads, moves, and deletes files and directories from the action's filesystem.
- Artifact Management - Uploads, downloads, and attests workflow artifacts for persistence across job steps or runs.
- Workflow Artifact Managers - Provides functions for uploading, downloading, and caching build artifacts across workflow runs.
- Admin Command Executions - Executes command-line tools and captures their output, exit code, or streams for further processing.
- External Command Execution - Runs external CLI programs and captures stdout, stderr, and exit codes for programmatic consumption.
- Recursive File Operations - Performs filesystem operations such as copying, moving, and recursively removing files.
- File Pattern Matching - Provides glob-based file search utilities for locating files within workflow workspaces.
- GitHub API Clients - Provides an authenticated Octokit client pre-loaded with workflow context for GitHub API calls.
- Context-Aware API Clients - Ships a context-aware Octokit client that automatically injects authentication and workflow metadata.
- Workflow Input-Output Handlers - Ships typed utilities for reading workflow inputs and setting outputs for downstream steps.
- Workflow Input Readers - Reads workflow inputs passed to the action and makes them available as typed values.
- Workflow Output Handlers - Sets outputs, status, and exit codes for a GitHub Actions workflow run.
- Workflow Output Writers - Writes named outputs from an action so downstream steps can consume them.
- CI Workflow Automations - Automates CI/CD pipelines by reading inputs, setting outputs, logging messages, and managing artifacts.
- Workflow Artifact Transfers - Persists files produced by a workflow step and retrieves them in later steps or runs.
- Cross-Platform File Operations - Provides a cross-platform file operation layer for copying, moving, and deleting files within actions.
- Structured Logging - Emits log messages at debug, info, warning, and error levels with consistent formatting for workflow visibility.
- Action Output Bindings - Sets action outputs, status codes, and exit signals that directly influence the parent workflow run.
- Authenticated API - Provides a pre-authenticated Octokit client for making GitHub API calls from workflows.
- Tool Binary Caches - Provides tool caching and execution utilities for downloading and running CLI tools in workflows.
- Binary Cache Managers - Downloads and stores tool binaries locally, then retrieves them on subsequent runs to avoid redundant downloads.
- Workflow Tool Binary Caches - Downloads tool binaries and caches them locally for reuse across workflow runs.
- Dependency Caches - Stores and restores tool binaries or dependency folders to accelerate repeated workflow executions.
- Glob-Based File Location - Locates files and directories by matching user-defined glob patterns against the workspace filesystem.
- Workflow Secret Access - Retrieves secrets and variables defined in the workflow environment at runtime.
- Workflow Secret Readers - Retrieves sensitive values and environment variables configured for the workflow run.
- Workflow Secret Retrievals - Retrieves workflow secrets and environment variables securely at runtime for use in action logic.
- Artifact Attestation Tools - Generates cryptographically signed provenance records linking workflow artifacts to their build metadata.
- Workflow Tool Download Caches - Downloads tool binaries and caches them so subsequent workflow runs reuse the local copy.
- Severity-Level Log Writers - Emits log messages at debug, info, warning, and error severity levels for workflow visibility.
- Action Development Tools - The GitHub ToolKit for developing GitHub Actions.
- Decision Records - Official architectural decision records for a major CI toolkit.
