Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meedamian/sync-readme
Github Action to sync README.md from Github to Docker Hub
https://github.com/meedamian/sync-readme
build-automation docker-hub github-actions readme-md
Last synced: about 4 hours ago
JSON representation
Github Action to sync README.md from Github to Docker Hub
- Host: GitHub
- URL: https://github.com/meedamian/sync-readme
- Owner: meeDamian
- License: mit
- Created: 2019-08-24T13:59:29.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-09T16:04:32.000Z (over 2 years ago)
- Last Synced: 2024-11-09T06:16:06.715Z (8 days ago)
- Topics: build-automation, docker-hub, github-actions, readme-md
- Language: Shell
- Size: 36.1 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# meeDamian/sync-readme
[![gh_last_release_svg]][gh_last_release_url]
[![tippin_svg]][tippin_url]
[gh_last_release_svg]: https://img.shields.io/github/v/release/meeDamian/sync-readme?sort=semver
[gh_last_release_url]: https://github.com/meeDamian/sync-readme/releases/latest
[tippin_svg]: https://img.shields.io/badge/donate-lightning-FDD023?logo=bitcoin&style=flat
[tippin_url]: http://btl.to/@meedamian
Github Action to sync `README.md` from Github to Docker Hub
# Usage
See [action.yml](action.yml)
## Warning
As of right now, this action **will not work** if you have 2FA on Docker Hub enabled!
It's impossible to login automatically when 2FA is used, and using Docker API Token results with:
```json
{"detail": "access to the resource is forbidden with personal access token"}
```
I'll try to update it as soon as the solution is found, and any suggestions welcome.
#### Minimal
If 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:
```yaml
steps:
- uses: actions/checkout@master
- uses: meeDamian/[email protected]
with:
pass: ${{ secrets.DOCKER_PASS }}
description: true
```
#### All custom
If everything needs to be specified:
```yaml
steps:
- uses: actions/checkout@master
- uses: meeDamian/[email protected]
with:
user: docker-username
pass: ${{ secrets.DOCKER_PASS }}
slug: organization/image-name
readme: ./docker/description.md
description: A must-have container, that you can't live without.
```
> **NOTE:** Add Docker Hub password to "Secrets" section in your repo's settings.
> **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.
> **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.
> **NOTE_3:** `master` branch may sometimes be broken, or change behavior. It's highly recommended to always use [tags].
[is done]: https://github.com/meeDamian/sync-readme/blob/master/entrypoint.sh#L32-L35
[tags]: https://github.com/meeDamian/sync-readme/tags
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE)