griffinplus/dockerhub-description repository overview

⁠Docker Hub Description

This docker image updates the description of an image at the Docker Hub⁠.

It is based on the work⁠ of Peter Evans.

⁠Using

To update the description of an image at the Docker Hub, you simply need to mount the markdown file to use as the image description into the container and set environment variables as follows:

docker run \
  -v $PWD:/workspace \
  -e DOCKERHUB_USERNAME='<username>' \
  -e DOCKERHUB_PASSWORD='<password>' \
  -e DOCKERHUB_REPOSITORY='<namespace>/<image>' \
  -e README_FILEPATH='/workspace/README.md' \
  griffinplus/dockerhub-description

⁠Environment Variables

⁠>>> DOCKERHUB_USERNAME [mandatory]

Docker Hub username. If updating a Docker Hub repository belonging to an organization, this user must have Admin permissions for the repository.

⁠>>> DOCKERHUB_PASSWORD [mandatory]

Docker Hub password.

⁠>>> DOCKERHUB_REPOSITORY [mandatory]

The Docker Hub repository to update in the format <namespace>/<name>.

⁠>>> README_FILEPATH

Path to the markdown file to upload to Docker Hub.

Default: /README.md

⁠>>> SHOW_TRACE

Determines whether the container emits a connection trace for issued HTTP requests. This can help to debug connection issues. These traces can contain sensitive information. Can be: true, false

Default: false

⁠License

This project is under the MIT License - see the LICENSE⁠ file for details.