docker/hub-tool

feature request: provide way to update a repo's description and full_description

actualben opened this issue · 8 comments

actualben commented

It would be nice to have a way to update the README content of a repo (I believe this is full_description in the API)

Output of hub-tool --version:

Docker Hub Tool v0.3.0, build 4b740d3
tianon commented

This is definitely the number one thing I want out of a Hub API / CLI tool (and is the reason I've been using the reverse-engineered/not-officially-supported Hub "API" for years 😂 😇).

  • 👍6
  • 😄1
actualben commented

docker/hub-feedback#1927 and docker/roadmap#115 contain some discussion related to updating readmes. It looks like there may be some parts of the API that need to be revised or finalized before this can happen?

  • 👍1
modem7 commented

docker/hub-feedback#1927 and docker/roadmap#115 contain some discussion related to updating readmes. It looks like there may be some parts of the API that need to be revised or finalized before this can happen?

docker/roadmap#115 really shouldn't have been closed until this was sorted tbf.

  • 👍10
actualben commented

Just recording some more interest/impact info for this feature; this general issue (need for an official API to update docker hub readmes) is also being tracked by several popular repos that would likely be consumers if it was implemented (instead they are currently relying on the unofficial APIs @tianon was referring to which don't work with 2FA+tokens):

Edit 11-Feb-2023
Support for auth-scoped tokens to update a repo's full_description and description via PATCH https://hub.docker.com/v2/repositories/REPO_NAME_HERE was added and announced by the Docker team on Jul 13, 2022 and community members have implemented support in their repos, including the GitHub Action peter-evans/dockerhub-description

  • 👍14
adripo commented

any update on this issue?

modem7 commented

any update on this issue?

Apparently resolved in docker/hub-feedback#2127 (comment) - no idea how though

  • 😕1
christian-korneck commented

same for me, I tried but it didn't seem to work. Does this work for anyone here? If so, I'd appreciate a pointer into the right direction.

reitzig commented

FWIW, this works for me: docker/hub-feedback#2127.1616804120 (cross-linking for people landing here via web search)