docker-hub-description-updater/README.md

docker hub description updater

By specifying the login data for hub.docker.com you can update the short and long description of a docker repository.

Usage

The examples below describe two ways to update the full description of the docker hub repository. First by the binary and second by a container based way.

dhdu \
  --user=<username> \
  --password=<password> \
  --namespace=<namespace> \
  --repository=<repository> \
  --file=./README.md

docker run \
  --rm \
  --volume $(pwd):/workspace \
    volkerraschek/dhdu \
      --user=<username> \
      --password=<password> \
      --namespace=<namespace> \
      --repository=<repository> \
      --file=./README.md

Compiling the source code

There are two different ways to compile dhdu from scratch. The easier ways is to use the pre-defined container image in the Makefile, which has included all dependancies to compile dhdu. Alternatively, if all dependencies are met, dhdu can also be compiled without the container image. Both variants are briefly described.

Compiling the source code via container image

To compile dhdu via container image it's necessary, that a container runtime is installed. In the Makefile is predefined docker, but it's can be also used podman. Execute make container-run/dhdu to start the compiling process.

make container-run/dhdu

Compiling the source code without container image

Make sure you have installed go >= v1.12. Execute make dhdu to compile dhdu without a container-image. There should be a similar output as when compiling dhdu via the container image.