From d60f2eca16950030d42177aab773f30c01ee05fd Mon Sep 17 00:00:00 2001
From: Fabian Meyer <3982806+meyfa@users.noreply.github.com>
Date: Mon, 8 Jul 2024 22:17:19 +0200
Subject: [PATCH] chore: Publish README to Docker Hub (#26)

Co-authored-by: Lukas Jost <lukas.jost@outlook.com>
---
 .github/workflows/publish.yml | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index 0488423..37cc8f2 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -9,7 +9,7 @@ permissions:
   contents: read
 
 jobs:
-  build:
+  publish:
     name: Build and Publish
     runs-on: ubuntu-latest
     steps:
@@ -52,3 +52,13 @@ jobs:
 
       - name: Image digest
         run: echo ${{ steps.docker-build.outputs.digest }}
+
+      # See: https://docs.docker.com/build/ci/github-actions/update-dockerhub-desc/
+      - name: Update DockerHub description
+        uses: peter-evans/dockerhub-description@e98e4d1628a5f3be2be7c231e50981aee98723ae # v4.0.0
+        with:
+          username: contane
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+          repository: contane/foreman
+          short-description: ${{ github.event.repository.description }}
+          enable-url-completion: true