actions /toolkit

The GitHub ToolKit for developing GitHub Actions.

★ 5,913⑂ 1,841👁 155⑃ 1,418● 787▤ 0
TypeScriptMITCreated 2019-04-19github.com/features/actions
More from this author
+1
Daily
5,913
stars
1,841
forks
155
watchers
1,418
prs
787
issues
0
releases

README

GitHub Actions Toolkit

The GitHub Actions ToolKit provides a set of packages to make creating actions easier.


Get started with the javascript-action template!


 Packages

:heavy_check_mark: @actions/core

Provides functions for inputs, outputs, results, logging, secrets and variables. Read more here

bash
npm install @actions/core



:runner: @actions/exec

Provides functions to exec cli tools and process output. Read more here

bash
npm install @actions/exec



:ice_cream: @actions/glob

Provides functions to search for files matching glob patterns. Read more here

bash
npm install @actions/glob



:phone: @actions/http-client

A lightweight HTTP client optimized for building actions. Read more here

bash
npm install @actions/http-client



:pencil2: @actions/io

Provides disk i/o functions like cp, mv, rmRF, which etc. Read more here

bash
npm install @actions/io



:hammer: @actions/tool-cache

Provides functions for downloading and caching tools.  e.g. setup- actions. Read more here

See @actions/cache for caching workflow dependencies.

bash
npm install @actions/tool-cache



:octocat: @actions/github

Provides an Octokit client hydrated with the context that the current action is being run in. Read more here

bash
npm install @actions/github



:floppy_disk: @actions/artifact

Provides functions to interact with actions artifacts. Read more here

bash
npm install @actions/artifact



:dart: @actions/cache

Provides functions to cache dependencies and build outputs to improve workflow execution time. Read more here

bash
npm install @actions/cache



:lock_with_ink_pen: @actions/attest

Provides functions to write attestations for workflow artifacts. Read more here

bash
npm install @actions/attest



 Creating an Action with the Toolkit

:question: Choosing an action type

Outlines the differences and why you would want to create a JavaScript or a container based action.



:curly_loop: Versioning

Actions are downloaded and run from the GitHub graph of repos.  This contains guidance for versioning actions and safe releases.



:warning: Problem Matchers

Problem Matchers are a way to scan the output of actions for a specified regex pattern and surface that information prominently in the UI.



:warning: Proxy Server Support

Self-hosted runners can be configured to run behind proxy servers.



Hello World JavaScript Action

Illustrates how to create a simple hello world javascript action.

javascript
...
  const nameToGreet = core.getInput('who-to-greet');
  console.log(Hello ${nameToGreet}!);
...



JavaScript Action Walkthrough

Walkthrough and template for creating a JavaScript Action with tests, linting, workflow, publishing, and versioning.

javascript
async function run() {
  try {
    const ms = core.getInput('milliseconds');
    console.log(Waiting ${ms} milliseconds ...)
    ...

javascript
PASS ./index.test.js
  ✓ throws invalid number
  ✓ wait 500 ms
  ✓ test runs

Test Suites: 1 passed, 1 total
Tests:       3 passed, 3 tota

Top issues

Discussions

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON