Public | Automated Build

Last pushed: 2 years ago
Short Description
Short description is empty for this repo.
Full Description

Did you ever find yourself creating automated builds by hand on http://hub.docker.com for each new git tag?
Why is it called automated build, if you can’t create a new one automatically? This project helps to
do the missing step.

There are plenty of articles describing a process where a central continuous build server (jenkins/travis/circleCI) builds
the image locally, and than pushes it to DockerHub. The end result of such a process is not an automated build.
Docker images which aren’t automated builds, considered a security risk and therefore should be voided.

Please note that the main purpose of this tool is: to be able to create a new automated DockerHub build from cli,
so it can be built easily integrated into any CI server/process.

Installation

go get github.com/progrium/dockerhub-tag

Usage

Usage:
  dockerhub-tag list   <dockerRepo>                                   [--verbose|-v]
  dockerhub-tag add    <dockerRepo> <dockerTag> <gitTag> <location>   [--verbose|-v]
  dockerhub-tag set    <dockerRepo> <dockerTag> <gitTag> <location>   [--verbose|-v]
  dockerhub-tag delete <dockerRepo> <dockerTag>                       [--verbose|-v]
  • list : Lists all automated buils in a table format.
  • add : Creates a new automated build pointing to a git Tag reference
  • set : Creates a new automated build pointing to a git Tag reference, while deletes all other Tag. (Branches are untouched)
  • delete : Deletes a Tag by name.

Authentication

Via environment variables

export DOCKERHUB_USERNAME=yourname
export DOCKERHUB_PASSWORD=Id0ntt3lU

Example

dockerhub-tag create gliderlabs/registrator 0.4.0 0.4.0 /

Single Dockerhub tag policy

Docker images are binary artifacts, so whenever you create a docker image tag based on
a github tag, it should be built only once.

Think about how you should never change a git tag, once you pushed it to the central repo.

It also creates unnecessary load on hub.dockler.com server if you rebuild the same
old (0.1.0, 0.1.1 0.1.2) docker images without any change.

Build once policy

While developing on a github branch, you will rebuild a docker image with the same tag,
like gliderlabs/registrator:master. But for tagged github version you want a matching
docker image tag built only once.

It wouldn’t make sense to build gliderlabs/registrator:v6 more than once, as it might
create a different docker image, resulting a potentially different behaviour, depending on
the exact time of the docker pull.

When you use dockerhub-tag set, it ensures to have a single git tag based automated build.
But when you push a change to a github branch, which has an automated build of branch type,
you will rebuild the tag type automated build as well.

To fulfill the build-once policy, you would need a mechanism to delete the tag based
automated build, after a successful build. But even than, while the tag based build
processes, one can push to a branch, triggering a new tag build (see the next section
about triggers)

So right now, your best option is to have 1 single tag based automated build, maintained
with dockerhub-tag set

Triggers

Since the new DockerHub version, the build trigger mechanism also changed. Previously the creation of
a new automated build, triggered the automated build process. At the new DockerHub version, you have
to explicitly trigger the build.

Theoretically there is a way to trigger only selected automated builds with token based triggers.
The documention shows an example:

# Trigger by Source tag named v1.1
$ curl \
  -H "Content-Type: application/json" \
  --data '&#123;"source_type": "Tag", "source_name": "v1.1"&#125;' \
  -X POST \
  https://registry.hub.docker.com/u/gliderlabs/registrator/trigger/12345678-1a1a-1234-abcd-1234567890ab/

Unfortunately, it seems that it still triggers all the automated builds.

Makefile

You can trigger dockerhub tag creation by make release, with a couple of lines:

DOCKERHUB_REPO=progrium/dockerhub-tag
GITHUB_REPO=progrium/dockerhub-tag
DOCKERFILE_LOCATION=/
VERSION=$(shell cat VERSION)

deps:
    go get github.com/progrium/gh-release/...
    go get github.com/progrium/dockerhub-tag

release:
    gh-release create $(GITHUB_REPO) $(VERSION)
    dockerhub-tag set $(DOCKERHUB_REPO) $(VERSION) $(VERSION) $(DOCKERFILE_LOCATION)

CircleCI

deployment:
  release:
    branch: release
    commands:
      - make release

Please remember to set env vars at Project Settings / Environment variables:

  • DOCKERHUB_USERNAME: authentication on hub.docker.com
  • DOCKERHUB_PASSWORD: credential on hub.docker.com
  • GITHUB_ACCESS_TOKEN: for creating the tag on github.com

tl;dr

Unfortunately none of the registry api versions gives you access to automated builds.

You can create docker image tags for nonautomated builds only:

Docker Pull Command
Owner
gliderlabs
Source Repository

Comments (0)