2023-02-04 11:51:49 +08:00
|
|
|
[](https://www.npmjs.com/package/@docker/actions-toolkit)
|
|
|
|
|
[](https://www.npmjs.com/package/@docker/actions-toolkit)
|
|
|
|
|
[](https://github.com/docker/actions-toolkit/actions?workflow=test)
|
|
|
|
|
[](https://codecov.io/gh/docker/actions-toolkit)
|
|
|
|
|
|
2023-01-17 18:49:39 +08:00
|
|
|
# Actions Toolkit
|
|
|
|
|
|
|
|
|
|
Toolkit for Docker (GitHub) Actions.
|
2023-01-31 10:22:02 +08:00
|
|
|
|
|
|
|
|
## :test_tube: 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](https://github.com/docker/bake-action)
|
|
|
|
|
* [docker/build-push-action](https://github.com/docker/build-push-action)
|
|
|
|
|
* [docker/login-action](https://github.com/docker/login-action)
|
|
|
|
|
* [docker/metadata-action](https://github.com/docker/metadata-action)
|
|
|
|
|
* [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action)
|
|
|
|
|
* [docker/setup-qemu-action](https://github.com/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](https://github.com/docker/buildx) and [BuildKit](https://github.com/moby/buildkit)
|
|
|
|
|
and provides an easier API for interacting with them.
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ npm install @docker/actions-toolkit
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```js
|
2023-02-21 15:12:26 +08:00
|
|
|
const { Toolkit } = require('@docker/actions-toolkit/lib/toolkit')
|
2023-01-31 10:22:02 +08:00
|
|
|
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](/.github/CONTRIBUTING.md)
|
