hub-tool icon indicating copy to clipboard operation
hub-tool copied to clipboard

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

Open actualben opened this issue 3 years ago • 8 comments

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

actualben avatar Apr 09 '21 12:04 actualben

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 :joy: :innocent:).

tianon avatar Jul 09 '21 06:07 tianon

https://github.com/docker/hub-feedback/issues/1927 and https://github.com/docker/roadmap/issues/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?

actualben avatar Nov 09 '21 14:11 actualben

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?

https://github.com/docker/roadmap/issues/115 really shouldn't have been closed until this was sorted tbf.

modem7 avatar Nov 22 '21 22:11 modem7

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

actualben avatar Dec 27 '21 14:12 actualben

any update on this issue?

adripo avatar May 03 '22 19:05 adripo

any update on this issue?

Apparently resolved in https://github.com/docker/hub-feedback/issues/2127#issuecomment-1082247689 - no idea how though

modem7 avatar May 03 '22 19:05 modem7

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.

christian-korneck avatar Jun 11 '22 01:06 christian-korneck

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

reitzig avatar Jul 02 '23 20:07 reitzig