Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iteratec/semantic-release-docker
a semantic-release plugin to use semver with docker images
https://github.com/iteratec/semantic-release-docker
docker semantic-release-plugin semver
Last synced: about 1 month ago
JSON representation
a semantic-release plugin to use semver with docker images
- Host: GitHub
- URL: https://github.com/iteratec/semantic-release-docker
- Owner: iteratec
- License: mit
- Created: 2018-05-18T20:29:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T17:32:30.000Z (almost 2 years ago)
- Last Synced: 2024-04-27T18:22:10.854Z (7 months ago)
- Topics: docker, semantic-release-plugin, semver
- Language: TypeScript
- Homepage:
- Size: 1.36 MB
- Stars: 10
- Watchers: 4
- Forks: 1
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @iteratec/semantic-release-docker
[](https://dev.azure.com/iteratec-oss-bdd/semantic-release-docker/_build/latest?definitionId=2&branchName=master)
[](https://github.com/semantic-release/semantic-release)
[](https://www.npmjs.com/package/@iteratec/semantic-release-docker)
[](https://www.npmjs.com/package/@iteratec/semantic-release-docker)
A [semantic-release](https://github.com/semantic-release/semantic-release) plugin to use semantic versioning for docker images.
## Supported Steps
### verifyConditions
verifies that environment variables for authentication via username and password are set.
It uses a registry server provided via config or environment variable (preferred) or defaults to docker hub if none is given.
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.
## Installation
Run `npm i --save-dev @iteratec/semantic-release-docker` to install this semantic-release plugin.
## Configuration
### 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. |
### 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 |
## Usage
full configuration:
```json
{
"verifyConfig": ["@iteratec/semantic-release-docker"],
"prepare": {
"path": "@iteratec/semantic-release-docker",
"additionalTags": ["test", "demo"],
"imageName": "my-image",
"registryUrl": "my-private-registry:5678",
"respositoryName": "my-repository"
},
"publish": {
"path": "@iteratec/semantic-release-docker"
}
}
```
results in `my-private-registry:5678/my-repository/my-image` with tags `test`, `demo` and the `` determined by `semantic-release`.
minimum configuration:
```json
{
"verifyConfig": ["@iteratec/semantic-release-docker"],
"prepare": {
"path": "@iteratec/semantic-release-docker",
"imageName": "my-image"
},
"publish": {
"path": "@iteratec/semantic-release-docker"
}
}
```
results in `my-image:`