From 7e6074b6677c569f12ab568cc76d6acc433f5a87 Mon Sep 17 00:00:00 2001
From: Jade Ellis <jade@ellis.link>
Date: Sat, 11 Jan 2025 14:12:08 +0000
Subject: [PATCH] publish README to docker hub

---
 .github/workflows/docker-hub-description.yml | 36 ++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 .github/workflows/docker-hub-description.yml

diff --git a/.github/workflows/docker-hub-description.yml b/.github/workflows/docker-hub-description.yml
new file mode 100644
index 000000000..5ff5f666d
--- /dev/null
+++ b/.github/workflows/docker-hub-description.yml
@@ -0,0 +1,36 @@
+name: Update Docker Hub Description
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - README.md
+      - .github/workflows/docker-hub-description.yml
+
+jobs:
+  dockerHubDescription:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Setting variables
+      uses: actions/github-script@v7
+      id: var
+      with:
+        script: |
+          const githubRepo = '${{ github.repository }}'.toLowerCase()
+          const repoId = githubRepo.split('/')[1]
+          
+          core.setOutput('github_repository', githubRepo)
+          const dockerRepo = '${{ vars.DOCKER_USERNAME }}'.toLowerCase() + '/' + repoId
+          core.setOutput('docker_repo', dockerRepo)
+    - name: Docker Hub Description
+      uses: peter-evans/dockerhub-description@v4
+      with:
+        username: ${{ vars.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+        repository: ${{ steps.var.outputs.docker_repo }}
+        short-description: ${{ github.event.repository.description }}
+        enable-url-completion: true