Skip to content
anchor

GitHub Action

Dockerhub Readme

v1 Latest version

Dockerhub Readme

anchor

Dockerhub Readme

sync Github <readme.md> with Dockerhub

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Dockerhub Readme

              
  uses: ms-jpq/sync-dockerhub-readme@v1
Learn more about this action in ms-jpq/sync-dockerhub-readme

Choose a version

Sync Dockerhub Readme

Sync <readme.md> to Dockerhub

Github Action

- name: Sync
  uses: ms-jpq/sync-dockerhub-readme@v1
  with:
    username: <dockerhub username>
    password: <dockerhub password>
    repository: <dockerhub name/repo>
    readme: "./README.md"

Docker Image

Docker Pulls

docker run -it --rm msjpq/sync-dockerhub-readme \
  --username <dockerhub username> \
  --password <dockerhub password> \
  --repo <dockerhub name/repo> \
  --readme './README.md'