{"repo":"peter-evans/dockerhub-description","free":true,"listed":false,"github":"https://github.com/peter-evans/dockerhub-description","clone":"git clone https://github.com/peter-evans/dockerhub-description.git","description":"A GitHub action to update a Docker Hub repository description from README.md","language":"TypeScript","stars":377,"topics":["dockerhub-description","dockerhub","docker","github-action"],"license":"MIT","category":"deployment-docker-iac","readme_excerpt":"Docker Hub Description A GitHub action to update a Docker Hub repository description from README.md . This is useful if you docker push your images to Docker Hub. It provides an easy, automated way to keep your Docker Hub repository description in sync with your GitHub repository README.md file. Usage Action inputs Name Description Default --- --- --- username ( required ) Docker Hub username. If updating a Docker Hub repository belonging to an organization, this user must have Admin permissions for the repository. password ( required ) Docker Hub password or Personal Access Token with read/write/delete scope. repository Docker Hub repository in the format / . github.repository short-description Docker Hub repository short description. readme-filepath Path to the repository readme. ./README.md enable-url-completion Enables completion of relative URLs to absolute ones. See also known Issues. false image-extensions File extensions that will be treated as images. bmp,gif,jpg,jpeg,png,svg,webp Content limits DockerHub has content limits. The readme content is limited to 25,000 bytes, and short-description is limited to 100 bytes. This action truncates content to prevent the request being rejected. If the content has been truncated a warning will be issued in the run log. Specifying the file path The action assumes that there is a file called README.md located at the root of the repository. If this is not the case the path can be specified with the readme-filepath input. Using the","default_branch":null,"files":null,"tree":[],"storefront":"/r/peter-evans","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/peter-evans/dockerhub-description/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}