Create dockerhub-description.yml

Enables the automatic sync of any changes to the GitHub README.md to the project's DockerHub page.
crocodilestick · Jul 27, 2024 · c198de0 · c198de0
1 parent 0da60c6
commit c198de0
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/.github/workflows/dockerhub-description.yml b/.github/workflows/dockerhub-description.yml
@@ -0,0 +1,22 @@
+name: Update Docker Hub Description
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - README.md
+      - .github/workflows/dockerhub-description.yml
+jobs:
+  dockerHubDescription:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Docker Hub Description
+      uses: peter-evans/dockerhub-description@v4
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_PASSWORD }}
+        repository: crocodilestick/calibre-web-automated
+        short-description: ${{ github.event.repository.description }}
+        enable-url-completion: true