# semantic-release-docker-test > semantic-release plugins to use semantic versioning with docker images Latest version **1.0.2** (published 2019-04-17) · MIT license · 0 weekly downloads ## Install ```sh npm install semantic-release-docker-test pnpm add semantic-release-docker-test yarn add semantic-release-docker-test bun add semantic-release-docker-test ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.2 | | Published | 2019-04-17 | | First published | 2019-04-17 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 60.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Christoph Murczek | | Maintainers | danielhabenicht | | Keywords | semantic-release, docker, semver | ## Links - npm: https://www.npmjs.com/package/semantic-release-docker-test - Repository: https://github.com/iteratec/semantic-release-docker - Homepage: https://github.com/iteratec/semantic-release-docker#readme - Issues: https://github.com/iteratec/semantic-release-docker/issues - npm.io page: https://npm.io/package/semantic-release-docker-test ## Dependencies (1) - [dockerode](https://npm.io/package/dockerode.md) ^2.5.7 ## Recent versions - 1.0.2 (latest) — 2019-04-17 - 1.0.1 — 2019-04-17 - 1.0.0-semantically-released — 2019-04-17 ## README # semantic-release-docker-test [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![latest npm package version](https://img.shields.io/npm/v/semantic-release-docker-test/latest.svg)](https://www.npmjs.com/package/semantic-release-docker-test) [![MIT license](https://img.shields.io/npm/l/semantic-release-docker-test.svg)](https://www.npmjs.com/package/semantic-release-docker-test) A [semantic-release](https://github.com/semantic-release/semantic-release) plugin to use semantic versioning for docker images. ## Configuration ### Installation `npm i --save semantic-release-docker-test` ### Docker registry authentication The `docker registry` authentication is **required** and can be set via environment variables. ### Environment variables | Variable | Description | | ------------------------ | ----------------------------------------------------------------------------------------- | | DOCKER_REGISTRY_URL | The hostname and port used by the desired docker registry. Leave blank to use docker hub. | | DOCKER_REGISTRY_USER | The user name to authenticate with at the registry. | | DOCKER_REGISTRY_PASSWORD | The password used for authentication at the registry. | ### Usage #### Full configuration ```json { "verifyConfig": ["semantic-release-docker-test"], "prepare": [ { "path": "semantic-release-docker-test", "additionalTags": ["test", "demo"], "imageName": "my-image", "registryUrl": "my-private-registry:5678", "respositoryName": "my-repository", "pushVersionTag": true } ], "publish": { "path": "semantic-release-docker-test" } } ``` Results in `my-private-registry:5678/my-repository/my-image` with tags `test`, `demo` and the `` determined by `semantic-release`. #### Minimum configuration ```json { "verifyConfig": ["semantic-release-docker-test"], "prepare": { "path": "semantic-release-docker-test", "imageName": "my-image" }, "publish": { "path": "semantic-release-docker-test" } } ``` Results in `my-image:`. ### Options | Option | Description | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | additionalTags | _Optional_. An array of strings allowing to specify additional tags to apply to the image. | | imageName | **_Required_** The name of the image to release. | | registryUrl | _Optional_. The hostname and port used by the the registry in format `hostname[:port]`. Omit the port if the registry uses the default port | | repositoryName | _Optional_. The name of the repository in the registry, e.g. username on docker hub | | pushVersionTag | _Optional_. Whether the semantic release tag, determined by the version, should be pushed. Default is `true`. | ## Steps ### verifyConditions It uses a registry server provided via config or environment variable (preferred) or defaults to docker hub if none is given. 1. Verifies that environment variables for authentication via username and password are set. 2. It also verifies that the credentials are correct by logging in to the given registry. ### prepare Tags the specified image with the version number determined by semantic-release and additional tags provided in the configuration. In addition it supports specifying a complete image name (CIN) via configuration settings according to the canonical format specified by docker: `[registryhostname[:port]/][username/]imagename[:tag]` ### publish Pushes the tagged images to the registry. ## Contribute ### Develop 1. Create a develop.ts file in the root of this Git-Repository and copy this: ```typescript import { SemanticReleaseConfig, SemanticReleaseContext } from 'semantic-release'; import { prepare, publish, verifyConditions } from './src'; import { DockerPluginConfig } from './src/models'; process.env.DOCKER_REGISTRY_USER = ''; process.env.DOCKER_REGISTRY_PASSWORD = ''; const config: SemanticReleaseConfig = { branch: '', noCi: true, repositoryUrl: '', tagFormat: '' }; const context: SemanticReleaseContext = { logger: { // tslint:disable-next-line:no-empty log: (message: string) => {} }, options: { branch: '', noCi: true, prepare: [ { additionalTags: ['latest'], imageName: 'testimage', repositoryName: '', path: 'semantic-release-docker-test' } as DockerPluginConfig, { additionalTags: ['latest'], imageName: 'testimage1', repositoryName: '', path: 'semantic-release-docker-test' } as DockerPluginConfig ], repositoryUrl: '', tagFormat: '' }, nextRelease: { version: '1.0.3', gitHead: '45jh345g', gitTag: 'v1.0.3', notes: 'Nothing special' } }; context.logger.log = (string: string) => { console.log(string); }; verifyConditions(config, context); prepare(config, context); publish(config, context); ``` 2. Simply run the "Debug" VS Code Task --- _Source: https://npm.io/package/semantic-release-docker-test · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._