actions-toolkit/README.md

Actions Toolkit

Toolkit for Docker (GitHub) Actions.

🧪 Experimental

This repository is considered EXPERIMENTAL and under active development until further notice. It is subject to non-backward compatible changes or removal in any future version.

About

This repository contains the source code for the toolkit that is consumed as a library by most of our GitHub Actions:

• docker/bake-action
• docker/build-push-action
• docker/login-action
• docker/metadata-action
• docker/setup-buildx-action
• docker/setup-qemu-action

This toolkit provides some utilities and common logic when developing GitHub Actions and also acts as a minimal wrapper around our build tooling such as Buildx and BuildKit and provides an easier API for interacting with them.

Installation

$ npm install @docker/actions-toolkit

Usage

const { Toolkit } = require('@docker/actions-toolkit/lib/toolkit')
const toolkit = new Toolkit()

Contributing

Want to contribute to the Actions Toolkit? Awesome! You can find information about contributing to this project in the CONTRIBUTING.md