GitHub toolkit

GitHub provides a toolkit to help facilitate building actions that we can use. This toolkit is composed of several packages, each specialized in one group of tools.

  • The core package provides functions for inputs, outputs, results, logging, secrets, and variables.
  • The exec package provides functions to execute CLI tools and process output.
  • The glob package provides functions to search for files matching glob patterns.
  • The http-client package provides a lightweight HTTP client optimized for building actions.
  • The io package provides disk i/o functions (like cp, mv, rmRF, which, etc).
  • The tool-cache package provides functions for downloading and caching tools.
  • The github package provides an Octokit client hydrated with the context that the current action is being run in.
  • The artifact package provides functions to interact with actions artifacts.
  • The cache package provides functions to cache dependencies and build outputs to improve workflow execution time.

Packages can be installed locally using

npm install @actions/package_name