From ce07f4d7af9eae3fd80c38ff3ecf5adb71b7b1b7 Mon Sep 17 00:00:00 2001
From: Gustavo Valverde <gustavo@iterativo.do>
Date: Sun, 4 Dec 2022 16:13:26 -0400
Subject: [PATCH] ci(docs): update our Docker Hub documentation with our README
 (#5779)

Previous behavior:

Our Docker Hub is missing the documentation we use in the Zebra repository

Expected behavior:

Each time we change our README.md, or on demand, update the documentation
on Docker Hub with it. Also update the short description using our repository
description.

Solution:

Implement https://github.com/peter-evans/dockerhub-description
---
 .github/workflows/dockerhub-description.yml | 30 +++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 .github/workflows/dockerhub-description.yml

diff --git a/.github/workflows/dockerhub-description.yml b/.github/workflows/dockerhub-description.yml
new file mode 100644
index 00000000..24a0b4f2
--- /dev/null
+++ b/.github/workflows/dockerhub-description.yml
@@ -0,0 +1,30 @@
+name: Update Docker Hub Description
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: false
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - README.md
+      - .github/workflows/dockerhub-description.yml
+
+jobs:
+  dockerHubDescription:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3.1.0
+        with:
+          persist-credentials: false
+
+      - name: Docker Hub Description
+        uses: peter-evans/dockerhub-description@v3.1.2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repository: zfnd/zebra
+          short-description: ${{ github.event.repository.description }}