docker / docker/buildx

Feature Request - update README.md when building from git repo

Open
#374 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
4.5k
Forks
682
Avg merge
2d 14h
Merged PRs (30d)
29

Description

Hi,
This is feature request is for README.md update when building from git repo.
Right now when using docker buildx a multi-arch image can be pushed to the docker hub using a git repo very elegantly.
But the README has to be updated manually or by using the hubs auto-build feature to build a unnecessary image to update README.md.

Is a update-readme option possible ?
docker buildx build -t user/repo:1.0 --platform=linux/arm,etc https://github.com/myrepo.git --update-readme --push
Here's a image of the builds with the additional "test" image, its only purpose being to update readme.
redundant_image_build_for_README_update

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the docker buildx build command and how a Git repository build is pushed to Docker Hub; the issue names no files or tests. Done means a documented --update-readme option can update the Docker Hub README during a multi-architecture push without requiring a redundant image build.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, go
Domain
cli, devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.