{"id":20673359,"url":"https://github.com/meedamian/sync-readme","last_synced_at":"2025-04-19T19:35:19.298Z","repository":{"id":65160854,"uuid":"204164759","full_name":"meeDamian/sync-readme","owner":"meeDamian","description":"Github Action to sync README.md from Github to Docker Hub","archived":false,"fork":false,"pushed_at":"2022-03-09T16:04:32.000Z","size":37,"stargazers_count":6,"open_issues_count":8,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-16T07:49:25.354Z","etag":null,"topics":["build-automation","docker-hub","github-actions","readme-md"],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/meeDamian.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-24T13:59:29.000Z","updated_at":"2024-05-01T06:25:06.000Z","dependencies_parsed_at":"2023-01-13T15:44:10.328Z","dependency_job_id":null,"html_url":"https://github.com/meeDamian/sync-readme","commit_stats":{"total_commits":18,"total_committers":1,"mean_commits":18.0,"dds":0.0,"last_synced_commit":"70e38f5bc63205951219b8e02afb1d6c1f57fa0a"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meeDamian%2Fsync-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meeDamian%2Fsync-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meeDamian%2Fsync-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meeDamian%2Fsync-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/meeDamian","download_url":"https://codeload.github.com/meeDamian/sync-readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249780760,"owners_count":21324616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["build-automation","docker-hub","github-actions","readme-md"],"created_at":"2024-11-16T20:41:06.456Z","updated_at":"2025-04-19T19:35:19.280Z","avatar_url":"https://github.com/meeDamian.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# meeDamian/sync-readme\n\n[![gh_last_release_svg]][gh_last_release_url]\n[![tippin_svg]][tippin_url]\n\n[gh_last_release_svg]: https://img.shields.io/github/v/release/meeDamian/sync-readme?sort=semver\n[gh_last_release_url]: https://github.com/meeDamian/sync-readme/releases/latest\n\n[tippin_svg]: https://img.shields.io/badge/donate-lightning-FDD023?logo=bitcoin\u0026style=flat\n[tippin_url]: http://btl.to/@meedamian\n\nGithub Action to sync `README.md` from Github to Docker Hub\n\n# Usage\n\nSee [action.yml](action.yml)\n\n\n## Warning\n\nAs of right now, this action **will not work** if you have 2FA on Docker Hub enabled!\n\nIt's impossible to login automatically when 2FA is used, and using Docker API Token results with:\n\n```json\n{\"detail\": \"access to the resource is forbidden with personal access token\"}\n```\n\nI'll try to update it as soon as the solution is found, and any suggestions welcome.\n\n#### Minimal\n\nIf your `user`-name, and the repo path (`slug`) are both the same on Github and Docker Hub, and `README.md` is located at repo's root, it's enough to:\n\n```yaml\nsteps:\n- uses: actions/checkout@master\n\n- uses: meeDamian/sync-readme@v1.0.6\n  with:\n    pass: ${{ secrets.DOCKER_PASS }}\n    description: true\n```\n\n#### All custom\n\nIf everything needs to be specified: \n\n```yaml\nsteps:\n- uses: actions/checkout@master\n\n- uses: meeDamian/sync-readme@v1.0.6\n  with:\n    user: docker-username\n    pass: ${{ secrets.DOCKER_PASS }}\n    slug: organization/image-name\n    readme: ./docker/description.md\n    description: A must-have container, that you can't live without.\n```\n\n\u003e **NOTE:** Add Docker Hub password to \"Secrets\" section in your repo's settings.\n \n\u003e **NOTE_1:** Docker Hub requires `user`, and `slug` to be lowercase.  Conversion [is done] automatically for you, so that Github's `meeDamian` becomes `meedamian` when passed to Docker.\n\n\u003e **NOTE_2:** `description` sets Docker Hub short description to its literal content in all cases, except when it's set to `true`, when Github repo description is used instead.  When skipped, no change is made to Docker Hub description.\n\n\u003e **NOTE_3:** `master` branch may sometimes be broken, or change behavior.  It's highly recommended to always use [tags].\n\n[is done]: https://github.com/meeDamian/sync-readme/blob/master/entrypoint.sh#L32-L35\n[tags]: https://github.com/meeDamian/sync-readme/tags\n\n# License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeedamian%2Fsync-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeedamian%2Fsync-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeedamian%2Fsync-readme/lists"}