From f8b3c027a5458678d9512df8880c30a06deb5b16 Mon Sep 17 00:00:00 2001
From: Vignesh Rao <svignesh1793@gmail.com>
Date: Wed, 11 Sep 2024 07:16:33 -0500
Subject: [PATCH] Update README.md Auto update docker hub description via GH
 workflow

---
 .github/workflows/description.yml | 23 +++++++++++++++++++++++
 README.md                         |  9 ++++++---
 2 files changed, 29 insertions(+), 3 deletions(-)
 create mode 100644 .github/workflows/description.yml

diff --git a/.github/workflows/description.yml b/.github/workflows/description.yml
new file mode 100644
index 0000000..665b714
--- /dev/null
+++ b/.github/workflows/description.yml
@@ -0,0 +1,23 @@
+name: Update Docker Hub Description
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - README.md
+      - .github/workflows/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.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_PASSWORD }}
+        repository: peterevans/dockerhub-description
+        # Spin up an on-demand self-hosted GitHub action runner with multi-arch supported Ubuntu image
+        short-description: ${{ github.event.repository.description }}
+        enable-url-completion: false
diff --git a/README.md b/README.md
index 24fc79e..f86f901 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 # GitHub Runner Linux
 
 [![Test Runner][badges-test]][links-test]
+<br>
 [![Build and Publish][badges-build]][links-build]
 
 Spin up an on-demand self-hosted GitHub action runner with multi-arch supported Ubuntu image.
@@ -31,6 +32,7 @@ docker compose up -d
 - **REUSE_EXISTING** - Re-use existing configuration. Defaults to `false`
 
 > [!NOTE]
+> 
 > `REUSE_EXISTING` flag can be useful when a container restarts due to an issue or
 > when a container is reused after being terminated without shutting down gracefully.
 > <details>
@@ -55,9 +57,10 @@ docker compose up -d
 > ```
 > </details>
 
-> [!WARNING]  
-Using this image **without** the env var `GIT_REPOSITORY` will create an organization level runner.
-Using self-hosted runners in public repositories pose some considerable security threats.
+> [!WARNING]
+> 
+> Using this image **without** the env var `GIT_REPOSITORY` will create an organization level runner.<br>
+> Using self-hosted runners in public repositories pose some considerable security threats.
 > - [#self-hosted-runner-security]
 > - [#restricting-the-use-of-self-hosted-runners]
 > - [#configuring-required-approval-for-workflows-from-public-forks]