Automatically update descriptions on Docker Hub

pandoc · Feb 10, 2025 · 45697dc · 45697dc
1 parent 4facacd
commit 45697dc
Showing 1 changed file with 46 additions and 0 deletions.
diff --git a/.github/workflows/dockerhub-description.yaml b/.github/workflows/dockerhub-description.yaml
@@ -0,0 +1,46 @@
+name: Update Docker Hub Description
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - versions.md
+      - README.md
+      - docs/**/*
+
+  workflow_dispatch:
+
+jobs:
+  strategy:
+    matrix:
+      image:
+        - minimal
+        - core
+        - latex
+        - extra
+        - typst
+
+  updateDescriptions:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Short description
+        id: config
+        run: |
+          printf 'short_description=%s\n' \
+            "$(pandoc lua docs/scripts/short-description.lua \
+                      ${{ matrix.image }})"
+
+      - name: Generate README files
+        run: |
+          make docs-${{ matrix.image }} > /tmp/README.${{ matrix.image }}.md
+
+      - name: minimal
+        uses: peter-evans/dockerhub-description@e98e4d1628a5f3be2be7c231e50981aee98723ae
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_TOKEN }}
+          repository: pandoc/${{ matrix.image }}
+          readme-filepath: /tmp/README.${{ matrix.image }}.md
+          short-description: ${{ steps.config.outputs.short_description }}