README

Docker Publish

Simple Docker tagging and publishing with 'npm version'

Prerequisite

Do not forget installing docker and running docker login before using it!

Install:

npm i -D @vanioinformatika/docker-publish

Best practice

Using npm run postversion: building image, creating docker tags and push into Docker Registry with one command.

In package.json set postversion:

"preversion": "git push && npm install && npm test",
"version": "",
"postversion": "git push && git push --tags && docker build -t $npm_package_config_docker_ns/$npm_package_name:latest . && docker-publish"

or with hands:

docker build -t namespace/appname:latest .
node ./node_modules/.bin/docker-publish

Configuration

There is zero configuration. All parameters comes from package.json: $npm_package_name and $npm_package_version variable (name and version properties).

* Maybe you want to use your own private docker repository, in this case please see the next chapter.

Customization

Optionally, in package.json you can customize your docker properties:

"version": "1.3.5",
"name": "docker-publish",
"config": {
  "docker": {
    "ns": "namespace",
    "url": "docker.yourcompany.com:5000",
    "name": "myapp",
    "skip": false,
    "silence": false,
    "strictSemver": false
  }
}

CLI parameters could overwites package.json properties (except version number).

DOCKER_NS: your namespace for image; namespace/imagename:tag Default: empty
DOCKER_URL: your private docker repository URL; docker.yourcompany.com:5000
DOCKER_NAME: overwrite image name. Default: package.json name properties
DOCKER_SKIP: Skip Docker tag and push commands (dry run with logging). Default: false
DOCKER_SILENCE: Do not logging. Default: false
DOCKER_STRICT_SEMVER: Strict semantic versioning tag. Default: false. If it is true, then only one tag will be created on docker image as https://semver.org defined and there is no 'v' before version number.

Releasing

Best practice: postversion contains image building and docker-publish, and running npm version

Output:

docker tag docker-publish:latest docker-publish:v1
docker tag docker-publish:latest docker-publish:v1.3
docker tag docker-publish:latest docker-publish:v1.3.5
docker tag docker-publish:latest docker-publish:v1.3.5-RELEASE-g993df1b
docker tag docker-publish:latest docker-publish:latest
docker push docker-publish:v1
docker push docker-publish:v1.3
docker push docker-publish:v1.3.5
docker push docker-publish:v1.3.5-RELEASE-g993df1b
docker push docker-publish:latest

v1.3.5-RELEASE-g993df1b: v1.3.5 - your version number from project.json, g993df1b - git commit ID (7 chars)

If DOCKER_STRICT_SEMVER, strictSemver is true, then:

docker tag docker-publish:latest docker-publish:1.3.5
docker push docker-publish:1.3.5

Snapshot

If you want to publish a snapshot, the image will be tagged with git commit id, and the commit's number since last version, and pushed. If DOCKER_STRICT_SEMVER, strictSemver is true, then snapshot is not available.