Skip to content

maxstealth/toolkit

 
 

Repository files navigation

GitHub Actions status

GitHub Actions Toolkit

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

Packages

The toolkit provides five separate packages. See the docs for each action.

Package Description
@actions/core Core functions for getting inputs, setting outputs, setting results, logging, secrets and environment variables
@actions/exec Functions necessary for running tools on the command line
@actions/io Core functions for CLI filesystem scenarios
@actions/tool-cache Functions necessary for downloading and caching tools
@actions/github An Octokit client hydrated with the context that the current action is being run in

Creating an Action with the Toolkit

Actions run in a container or on the host machine.

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

Hello World JavaScript Action: Illustrates how to create a simple hello world javascript action.

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

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

Docker Action Walkthrough: Create an action that is delivered as a container and run with docker.

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

Versioning: Recommendations on versioning, releases and tagging your action.

Contributing

We welcome contributions. See how to contribute.

About

The GitHub ToolKit for developing GitHub Actions.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 97.4%
  • PowerShell 1.4%
  • Other 1.2%