An open API service indexing awesome lists of open source software.

https://github.com/raiper34/release-it-docker-plugin

Plugin to ability build docker images and push to docker hub in release-it workflow.
https://github.com/raiper34/release-it-docker-plugin

automatic-release docker docker-hub docker-plugin plugin release release-it

Last synced: about 2 months ago
JSON representation

Plugin to ability build docker images and push to docker hub in release-it workflow.

Awesome Lists containing this project

README

          

[![npm version](https://badge.fury.io/js/release-it-docker-plugin.svg)](https://badge.fury.io/js/release-it-docker-plugin)
![npm bundle size](https://img.shields.io/bundlephobia/min/release-it-docker-plugin)
![NPM](https://img.shields.io/npm/l/release-it-docker-plugin)
[![GitHub Workflow Status](https://github.com/raiper34/release-it-docker-plugin/actions/workflows/test.yml/badge.svg)](https://github.com/Raiper34/release-it-docker-plugin)
[![npm](https://img.shields.io/npm/dt/release-it-docker-plugin)](https://badge.fury.io/js/release-it-docker-plugin)
[![npm](https://img.shields.io/npm/dm/release-it-docker-plugin)](https://badge.fury.io/js/release-it-docker-plugin)
[![npm](https://img.shields.io/npm/dw/release-it-docker-plugin)](https://badge.fury.io/js/release-it-docker-plugin)
[![](https://data.jsdelivr.com/v1/package/npm/release-it-docker-plugin/badge?style=rounded)](https://www.jsdelivr.com/package/npm/release-it-docker-plugin)
[![GitHub Repo stars](https://img.shields.io/github/stars/raiper34/release-it-docker-plugin)](https://github.com/Raiper34/release-it-docker-plugin)

# Release It! 🚀 - Docker plugin

Plugin to ability build docker images and push to docker hub in release-it workflow.

### Content
- [🚀 Instalation](#-instalation)
- [💻 Usage](#-usage)
- [Options](#options)
- [📖 License](#-license)

# 🚀 Instalation

Install library using npm:
```shell
npm install release-it-docker-plugin --save-dev
```

# 💻 Usage
Use the plugin in `.release-it.json` as follows:
```json
{
"$schema": "https://unpkg.com/release-it/schema/release-it.json",
...
"plugins": {
...
"release-it-docker-plugin": {
"build": true,
"push": true,
"latestTag": true,
"imageName": ""
}
}
}
```

## Options
The plugin can be configured with the following options:

| Name | Default value | Description |
|-----------|---------------|-------------------------------------------------------------------------------------------------------------|
| imageName | undefined | name of docker image to build and push |
| latestTag | false | if also `latest` tag should be built and pushed |
| buildx | false | if plugin should use new buildx tool |
| build | false | if plugin should build docker image, only applicable without with buildx |
| push | false | if plugin should push docker image to docker hub, only applicable without with buildx |
| builder | undefined | builder name, only applicable together with buildx |
| output | registry | where image will be stored (available options `docker` or `registry`), only applicable together with buildx |

# 📖 License
MIT