The toolkit's intro from gusjang69

gusjang69 / toolkit Goto Github PK

View Code? Open in Web Editor NEW

This project forked from actions/toolkit

The GitHub ToolKit for developing GitHub Actions.

License: MIT License

JavaScript 0.77% TypeScript 97.37% Shell 0.14% Batchfile 0.11% C# 0.19% PowerShell 1.43%

toolkit's Introduction

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.