Update Readme and description with push on Docker hub

[SivaKesava1]

Currently, if we use the Github action with this repo, the image is built and pushed to the Docker hub, but the Readme and description are not updated on the Docker hub webpage. It would be nice to have this in the future to use this action and altogether disable auto build.

[zappy-shu]

Hi @SivaKesava1. We want to take a look at matching functionality with auto-builds so this is great feedback. Any thoughts @nebuk89?

[felipecrs]

By the way, I've been using https://github.com/marketplace/actions/docker-hub-description to do that.

[christian-korneck]

Here's another github action that can set/update the container repo description from the README in the github repo.
It supports container repos on Docker Hub, Harbor v2 and Quay.

For Dockerhub it's possible to set both the short description and the full description (README).

update-container-description

[lirantal]

@crazy-max and folks, can we re-open this to get this core capability as part of this official docker action? I'd rather use that than start piling up on third-party actions. Regardless of the community ecosystem around Docker related actions, I think this is a very core capability that I'd expect to have with this action.

[christian-korneck]

@lirantal +1 for this. For the meantime, I created a Docker CLI plugin and a github action based on it to fill this gap. Feel free to open an issue if you feel it doesn't serve your needs. (Yes, it's an additional action/job step ... but github actions is all about modularity imho).

[lirantal]

Thanks!

Maybe it's worth to ping @peter-evans and ask if they'd like to contribute a pull request that adds this capability to this official action?

[crazy-max]

We will work on this. Keep you in touch! (cc @technicallyjosh)

@lirantal Some changes may be required to allow a PAT to modify the README on Docker Hub. ATM only username/password credentials work.

[whizzzkid]

Did the team ever got around fixing this?

[christian-korneck]

@whizzzkid Did the team ever got around fixing this?

yes, it's now possible to set the repo description when authenticated with a PAT (was fixed earlier this year, there was another github issue about it that I can't seem to find at the moment). (Thanks to anyone from the Docker Hub team involved with this!)

[djbrown]

the documentation using the third party action is available here: https://docs.docker.com/build/ci/github-actions/examples/#update-docker-hub-repository-description

but this issue is open to add that functionality into this action, correct?

[srstsavage]

+1, pushing updates to the Docker Hub README should 100% be part of the core functionality.

[Alw3ys]

@djbrown link is broken, for the next ones coming here to find the link. here it is:

https://docs.docker.com/build/ci/github-actions/update-dockerhub-desc/

[technicallyjosh]

Seems this one went a bit under the radar for too long 😅. Should be an easy PR to pop in. Will work on this week to include repo description to update.

Edit: So after discussing with @crazy-max, we believe the best way forward is to keep the updating of the description in a separate action as this action is fully revolved around Buildx. We have some ideas to make this a bit easier with reusing the same bearer token obtained from login though. Some PRs are gonna come to make smaller quality of life improvements.

[baruchiro]

@technicallyjosh @crazy-max Can you please give us a link to the new issue you're working with, so we can follow the work there?

Thank you!

[add-n2x]

Should this be still working? I get "forbidden" messages and assume it's not working in the free DockerHub plan anymore.

[christian-korneck]

@add-n2x I haven't tried this action, but my tool Docker Push Readme, which roughly uses the same mechanism, still works. (Tried today with Docker Hub, with a free account, with a personal access token (PAT)). So there's unlikely a new restriction on the Docker Hub side.

[snowdream]

I have tried christian-korneck/update-container-description-action .

This github action updates the description of a container repo on Docker Hub, Quay or Harbor v2 from a README file.

This is useful when building and pushing Docker images with github actions. It can ensure that the description of a container repo stays in sync with the README file in the github repo.

https://github.com/snowdreamtech/base/blob/main/.github/workflows/description.yml