{"id":21834393,"url":"https://github.com/hmajid2301/dockerhub-description-updater","last_synced_at":"2026-05-07T09:34:29.620Z","repository":{"id":43979607,"uuid":"245864130","full_name":"hmajid2301/dockerhub-description-updater","owner":"hmajid2301","description":"Docker Image used to update the description on Docker Hub repos. Mirrored from, https://gitlab.com/hmajid2301/dockerhub-descriptions-updater","archived":false,"fork":false,"pushed_at":"2024-07-07T17:38:18.000Z","size":544,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-03-29T21:06:54.850Z","etag":null,"topics":["cli","dockerhub","npm","script"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hmajid2301.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-03-08T18:11:42.000Z","updated_at":"2021-03-04T08:16:59.000Z","dependencies_parsed_at":"2025-10-25T07:52:46.322Z","dependency_job_id":"f9a67a75-a422-4dcc-ba93-11454fc9b79a","html_url":"https://github.com/hmajid2301/dockerhub-description-updater","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/hmajid2301/dockerhub-description-updater","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmajid2301%2Fdockerhub-description-updater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmajid2301%2Fdockerhub-description-updater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmajid2301%2Fdockerhub-description-updater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmajid2301%2Fdockerhub-description-updater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hmajid2301","download_url":"https://codeload.github.com/hmajid2301/dockerhub-description-updater/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hmajid2301%2Fdockerhub-description-updater/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32731616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-07T02:14:30.463Z","status":"ssl_error","status_checked_at":"2026-05-07T02:14:29.405Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","dockerhub","npm","script"],"created_at":"2024-11-27T20:10:32.169Z","updated_at":"2026-05-07T09:34:29.604Z","avatar_url":"https://github.com/hmajid2301.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker Hub Description\n\nDocker Image used to update the description on Docker Hub repos. The image comes with pandoc so you convert your\ndocuments to markdown.\n\n## Usage\n\nYou can the node script like so.\n\n```\nnpm install dockerhub\nnpm i dockerhub-description-updater\ntouch .env\nsource .env\ndockerhub_description_updater\n```\n\n### Args\n\n```bash\ndockerhub_description_updater --help\nUsage: src [options]\n\n  Updates description of Docker Hub repository.\n\nOptions:\n  --version         Show version number                               [boolean]\n  -u, --username    Docker Hub username.                              [required]\n  -p, --password    Docker Hub password (cannot be an access token).  [required]\n  -r, --repoName    The repository name that you want to update the description\n                    off.                                              [required]\n  -x, --repoPrefix  The prefix of the repository you want to  update, If not set\n                    defaults to username.\n  -f, --readmePath  Path to README file which will be used as the description of\n                    repository on Docker Hub.           [default: \"./README.md\"]\n  -h, --help        Show help                                          [boolean]\n```\n\n### Docker\n\nYou can run the Docker container locally like so.\n\n```bash\ntouch .env\ndocker run -rm -v README.md:/app/README.md --env-file .env hmajid2301/dockerhub-descriptions-updater\n```\n\nor you can build it locally\n\n```\nnpm run build\ndocker build -t dockerhub-descriptions-updater .\ndocker run -v README.md:/app/README.md --env-file .env dockerhub-descriptions-updater\n```\n\nWhere `.env` is like:\n\n```.env\nDOCKERHUB_USERNAME=hmajid2301\nDOCKERHUB_PASSWORD=MY_PASS\nDOCKERHUB_REPO_PREFIX=hmajid2301\nDOCKERHUB_REPO_NAME=dockerhub-descriptions-updater\nDOCKERHUB_README_PATH=/app/README.md\n```\n\n### .gitlab-ci.yml\n\nYou can also use it during CI/CD. The image comes with `pandoc`, so you can convert documents to markdown and\nthen update the full description to the specified repo.\n\n```yaml\npublish-readme:hub:\n  stage: pre-publish\n  image:\n    name: hmajid2301/dockerhub-descriptions\n    entrypoint: [\"\"]\n  variables:\n    DOCKERHUB_USERNAME: hmajid2301\n    DOCKERHUB_PASSWORD: ${DOCKER_PASSWORD}\n    DOCKERHUB_REPO_NAME: markdown-to-devto\n    DOCKERHUB_README_PATH: README.md\n    publish-readme:hub:\n  script:\n    - pandoc --from rst README.rst --to markdown_strict -o README.md\n    - node /app/index.js\n```\n\n## Appendix\n\n- Inspired by [sheogorath/readme-to-dockerhub](https://hub.docker.com/r/sheogorath/readme-to-dockerhub/dockerfile)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmajid2301%2Fdockerhub-description-updater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhmajid2301%2Fdockerhub-description-updater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmajid2301%2Fdockerhub-description-updater/lists"}