From a1ed6319d3a3a674b6aaa45d8a85923545dbab8f Mon Sep 17 00:00:00 2001
From: AML - A Laycock <aml@lhs.lancs.sch.uk>
Date: Wed, 31 Jan 2024 08:37:00 +0000
Subject: [PATCH] ci: update docs only on version release

---
 .github/workflows/deployment.yml | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml
index 341ab24..e18b47e 100644
--- a/.github/workflows/deployment.yml
+++ b/.github/workflows/deployment.yml
@@ -202,6 +202,18 @@ jobs:
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,mode=max,dest=/tmp/.buildx-cache-new
 
+      - name: 📃 Push Read Me
+        uses: christian-korneck/update-container-description-action@v1
+        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+        env:
+          DOCKER_USER: ${{ secrets.DOCKER_USERNAME }}
+          DOCKER_PASS: ${{ secrets.DOCKER_PASSWORD }}
+        with:
+          destination_container_repo: longridgehighschool/start-screen
+          provider: dockerhub
+          short_description: 'Highly customizable Start Screen for schools'
+          readme_file: 'README.md'
+
       # This ugly bit is necessary if you don't want your cache to grow forever
       # till it hits GitHub's limit of 5GB.
       # Temp fix
@@ -239,7 +251,7 @@ jobs:
         run: cd docs && npm run build
 
       - name: 🚀 Deploy
-        if: ${{ github.ref == 'refs/heads/main' }}
+        if: ${{ startsWith(github.ref, 'refs/tags/v') }}
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           branch: gh-pages