add in readme.md sync

.github/workflows/docker-tag-triggered-prod.yml

@@ -25,16 +25,23 @@ jobs:
             make
             sudo make install
       - name: Login to Docker Hub
-        uses: docker/login-action@v1 
+        uses: docker/login-action@v1
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
       - name: Login to GitHub Container Registry (GHCR)
-        uses: docker/login-action@v1 
+        uses: docker/login-action@v1
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.CR_PAT }}
+      - name: Sync GitHub README.md with Docker Hub
+        uses: peter-evans/dockerhub-description@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }} # NOTE: This MUST be the password NOT the token
+          repository: ${{ github.repository }}Hub
+          short-description: ${{ github.event.repository.description }}
       - name: DEBUG Show Runners environment
         uses: nick-invision/retry@v2.4.0
         with:
@@ -46,7 +53,7 @@ jobs:
             export
       - name: Identify GitHub tag name
         # get tag name from runners environment 'GITHUB_REF' and then use bash substring
-        # to strip out '+' symbol - required due to gcr not supporting this as a tag 
+        # to strip out '+' symbol - required due to gcr not supporting this as a tag
         # name (docker hub does support it).
         # note if push is NOT triggered by tag then 'GITHUB_REF' will be the branch name.
         uses: nick-invision/retry@v2.4.0