@codedependant/semantic-release-docker

@codedependant/semantic-release-docker

A 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

builds a an image using the specified docker file and context. This image will be used to create tags in later steps

publish

pushes the tags Images with specified tags and pushes them to the registry. Tags support simple templating. Values enclosed in braces {} will be subsititued with release context information

Installation

Run npm i --save-dev @codedependant/semantic-release-docker to install this semantic-release plugin.

Configuration

Docker registry authentication

The docker registry authentication set via environment variables. It is not required, and if omitted, it is assumed the docker daemon is already authenticated with the targe registry.

Environment variables

Variable	Description
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	Default
docker.tags	Optional. An array of strings allowing to specify additional tags to apply to the image.	[latest, {major}-latest, {version}]
docker.image	Optional. The name of the image to release.	Parsed from package.json name property
docker.registry	Optional. The hostname and port used by the the registry in format hostname[:port]. Omit the port if the registry uses the default port	null (dockerhub)
docker.project	Optional. The project or repository name to publish the image to	For scoped packages, the scope will be used, otherwise null
docker.dockerfile	Optional. The path, relative to $PWD to a Docker file to build the target image with	Dockerfile
docker.context	Optional. A path, relative to $PWD to use as the build context A	.

Usage

full configuration:

{
  "release": {
    "plugins": [
      ["@codedependant/semantic-release-docker", {
        "docker": {
          "tags": ["latest", "{version}", "{major}-latest", "{major}.{minor}"],
          "image": "my-image",
          "dockerfile": "Dockerfile",
          "registry": "quay.io",
          "project": "codedependant"
        }
      }]
    ]
  }
}

results in quay.io/codedependant/my-image with tags latest, 1.0.0, 1-latest and the 1.0 determined by semantic-release.

Alternatively, using global options w/ root configuration

{
  "release": {
    "extends": "@internal/release-config-example",
    "docker": {
      "tags": ["latest", "{version}", "{major}-latest", "{major}.{minor}"],
      "image": "my-image",
      "dockerfile": "Dockerfile",
      "registry": "quay.io",
      "project": "codedependant"
    }
  }
}

minimum configuration:

{
  "release": {
    "plugins": [
      "@codedependant/semantic-release-docker"
    ]
  }
}

• A package name @codedependant/test-project results in codedependant/test-project
• A package name test-project results in test-project

the default docker image tags for the 1.0.0 release would be 1.0.0, 1-latest, latest

Development

Docker Registry

To be able to push to the local registry with auth credentials, ssl certificates are required. This project uses self signed certs. To regenerate the certs run the following:

$ openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 -keyout server.key -out server.crt

NOTE: When prompted for an FQDN it must be registry:5000 NOTE: The credentials for the local registry are user: iamweasel, pass: secretsquirrel