Repository files navigation

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

✔️@actions/core

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

$ npm install @actions/core

🏃@actions/exec

Provides functions to exec cli tools and process output. Read morehere

$ npm install @actions/exec

🍨@actions/glob

Provides functions to search for files matching glob patterns. Read morehere

$ npm install @actions/glob

☎️@actions/http-client

A lightweight HTTP client optimized for building actions. Read morehere

$ npm install @actions/http-client

✏️@actions/io

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

$ npm install @actions/io

🔨@actions/tool-cache

Provides functions for downloading and caching tools. e.g. setup-* actions. Read morehere

See @actions/cache for caching workflow dependencies.

$ npm install @actions/tool-cache

@actions/github

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

$ npm install @actions/github

💾@actions/artifact

Provides functions to interact with actions artifacts. Read morehere

$ npm install @actions/artifact

🎯@actions/cache

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

$ npm install @actions/cache

❓Choosing an action type

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

➰Versioning

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

⚠️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.

⚠️Proxy Server Support

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

Illustrates how to create a simple hello world javascript action.

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

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

asyncfunctionrun(){try{constms=core.getInput('milliseconds');console.log(`Waiting${ms} milliseconds ...`)...

PASS./index.test.js✓throwsinvalidnumber✓wait500ms✓testrunsTestSuites:1passed,1totalTests:3passed,3total

Walkthrough creating a TypeScript Action with compilation, tests, linting, workflow, publishing, and versioning.

import*ascorefrom'@actions/core';asyncfunctionrun(){try{constms=core.getInput('milliseconds');console.log(`Waiting${ms} milliseconds ...`)...

PASS./index.test.js✓throwsinvalidnumber✓wait500ms✓testrunsTestSuites:1passed,1totalTests:3passed,3total

Create an action that is delivered as a container and run with docker.

FROM alpine:3.10COPY LICENSE README.md /COPY entrypoint.sh /entrypoint.shENTRYPOINT ["/entrypoint.sh"]

Create an action that is delivered as a container which uses the toolkit. This example uses the GitHub context to construct an Octokit client.

FROM node:slimCOPY . .RUN npm install --productionENTRYPOINT ["node", "/lib/main.js"]

constmyInput=core.getInput('myInput');core.debug(`Hello${myInput} from inside a container`);constcontext=github.context;console.log(`We can even get context data, like the repo:${context.repo.repo}`)

We welcome contributions. Seehow to contribute.

Seeour code of conduct.