maurosoft1973/alpine-readme-to-dockerhub repository overview

⁠README to Docker Hub

This Docker image (maurosoft1973/alpine-readme-to-dockerhub)⁠ is based on the minimal Alpine Linux⁠.

⁠Alpine Version 3.17.3 (Released Mar 29 2023)

⁠Description

This is a quick hack to push README.md files and short description to Docker hub.

FULL_DESCRIPTION=$(if [ -f "/path/to/README.md" ]; then cat "/path/to/README"; else echo ""; fi)

docker run --rm \
    -e DOCKERHUB_USERNAME=username \
    -e DOCKERHUB_PASSWORD=password \
    -e DOCKERHUB_REPO_PREFIX=organization \
    -e DOCKERHUB_REPO_NAME=repository \
    -e FULL_DESCRIPTION="$FULL_DESCRIPTION"
    -e SHORT_DESCRIPTION="Short Description of image"
     maurosoft1973/alpine-readme-to-dockerhub

That's it.

The user you use to push the README.md need to be admin of the repository.

⁠Architectures

• :aarch64 - 64 bit ARM
• :armhf - 32 bit ARM v6
• :armv7 - 32 bit ARM v7
• :ppc64le - 64 bit PowerPC
• :x86 - 32 bit Intel/AMD
• :x86_64 - 64 bit Intel/AMD (x86_64/amd64)

⁠Tags

• :latest latest branch based (Automatic Architecture Selection)
• :aarch64 latest 64 bit ARM
• :armhf latest 32 bit ARM v6
• :armv7 latest 32 bit ARM v7
• :ppc64le latest 64 bit PowerPC
• :x86 latest 32 bit Intel/AMD
• :x86_64 latest 64 bit Intel/AMD
• :test test branch based (Automatic Architecture Selection)
• :test-aarch64 test 64 bit ARM
• :test-armhf test 32 bit ARM v6
• :test-armv7 test 32 bit ARM v7
• :test-ppc64le test 64 bit PowerPC
• :test-x86 test 32 bit Intel/AMD
• :test-x86_64 test 64 bit Intel/AMD
• :3.17.3 3.17.3 branch based (Automatic Architecture Selection)
• :3.17.3-aarch64 3.17.3 64 bit ARM
• :3.17.3-armhf 3.17.3 32 bit ARM v6
• :3.17.3-armv7 3.17.3 32 bit ARM v7
• :3.17.3-ppc64le 3.17.3 64 bit PowerPC
• :3.17.3-x86 3.17.3 32 bit Intel/AMD
• :3.17.3-x86_64 3.17.3 64 bit Intel/AMD

⁠Layers & Sizes

Version	Size

⁠Environment Variables:

⁠Example of use

⁠1.Example for update short description and full description with GITLAB Pipeline.

Your define the variables $DOCKER_HUB_USER and $DOCKER_HUB_PASSWORD (https://gitlab.com/help/ci/variables/README#variables⁠) into "Settings -> CI/CD -> Variables" on the repository

image: docker:stable

stages:
  - readme

readme:
  stage: readme
  variables:
    DOCKERHUB_USERNAME: "$DOCKER_HUB_USER"
    DOCKERHUB_PASSWORD: "$DOCKER_HUB_PASSWORD"
    DOCKERHUB_REPO_PREFIX: "myorganization"
    DOCKERHUB_REPO_NAME: "myrepository"
  script:
  - FULL_DESCRIPTION=$(if [ -f "$(pwd)/README.md" ]; then cat "$(pwd)/README.md"; else echo ""; fi)
  - docker pull maurosoft1973/alpine-readme-to-dockerhub:latest
  - docker run --rm -e DOCKERHUB_USERNAME="$DOCKERHUB_USERNAME" -e DOCKERHUB_PASSWORD="$DOCKERHUB_PASSWORD" -e DOCKERHUB_REPO_PREFIX="$DOCKERHUB_REPO_PREFIX" -e DOCKERHUB_REPO_NAME="$DOCKERHUB_REPO_NAME" -e SHORT_DESCRIPTION="Your short description" -e FULL_DESCRIPTION="$FULL_DESCRIPTION" maurosoft1973/alpine-readme-to-dockerhub

⁠Last Update 29.04.2023 10:19:55