Skip to content
forked from actions/toolkit

The GitHub ToolKit for developing GitHub Actions.

License

Notifications You must be signed in to change notification settings

shmargum/toolkit

This branch is 199 commits behind actions/toolkit:main.

Folders and files

NameName
Last commit message
Last commit date
Apr 10, 2024
Feb 1, 2024
May 20, 2024
Jul 10, 2019
Jan 3, 2023
Aug 7, 2023
Aug 7, 2023
Jul 15, 2020
Aug 7, 2023
Aug 3, 2023
Feb 26, 2024
Oct 9, 2019
Aug 25, 2020
Feb 26, 2024
Oct 9, 2019
Jan 9, 2024
Aug 3, 2023
Aug 3, 2023
Apr 10, 2024
Apr 15, 2024
Apr 13, 2020
Sep 8, 2023

Repository files navigation

Toolkit unit tests status Toolkit audit status

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

βœ”οΈ @actions/core

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

$ npm install @actions/core

πŸƒ @actions/exec

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

$ npm install @actions/exec

🍨 @actions/glob

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

$ npm install @actions/glob

☎️ @actions/http-client

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

$ npm install @actions/http-client

✏️ @actions/io

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

$ npm install @actions/io

πŸ”¨ @actions/tool-cache

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

See @actions/cache for caching workflow dependencies.

$ 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

$ npm install @actions/github

πŸ’Ύ @actions/artifact

Provides functions to interact with actions artifacts. Read more here

$ npm install @actions/artifact

🎯 @actions/cache

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

$ npm install @actions/cache

πŸ” @actions/attest

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

$ npm install @actions/attest

Creating an Action with the Toolkit

❓ 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.

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

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

async function run() {
  try {
    const ms = core.getInput('milliseconds');
    console.log(`Waiting ${ms} milliseconds ...`)
    ...
PASS ./index.test.js
  βœ“ throws invalid number
  βœ“ wait 500 ms
  βœ“ test runs

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

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

import * as core from '@actions/core';

async function run() {
  try {
    const ms = core.getInput('milliseconds');
    console.log(`Waiting ${ms} milliseconds ...`)
    ...
PASS ./index.test.js
  βœ“ throws invalid number
  βœ“ wait 500 ms
  βœ“ test runs

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


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

FROM alpine:3.10
COPY LICENSE README.md /
COPY entrypoint.sh /entrypoint.sh
ENTRYPOINT ["/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:slim
COPY . .
RUN npm install --production
ENTRYPOINT ["node", "/lib/main.js"]
const myInput = core.getInput('myInput');
core.debug(`Hello ${myInput} from inside a container`);

const context = github.context;
console.log(`We can even get context data, like the repo: ${context.repo.repo}`)

Contributing

We welcome contributions. See how to contribute.

Code of Conduct

See our code of conduct.

About

The GitHub ToolKit for developing GitHub Actions.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.7%
  • Other 1.3%