From bdd5b547acf225beb1267695b415510dd1785a2c Mon Sep 17 00:00:00 2001
From: Mohamed Elashri <mail@elashri.com>
Date: Fri, 15 Nov 2024 22:44:12 -0500
Subject: [PATCH] Add linter to the generate_readme action

---
 .github/workflows/generate-readme.yml | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/.github/workflows/generate-readme.yml b/.github/workflows/generate-readme.yml
index a8b5271..b46b51a 100644
--- a/.github/workflows/generate-readme.yml
+++ b/.github/workflows/generate-readme.yml
@@ -1,20 +1,28 @@
 name: Update README
+
 on:
   push:
     branches:
       - main
     paths:
       - '_README.md'
+
 jobs:
   update-readme:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
+
       - name: Generate README.md
         run: |
           python3 generate_readme.py _README.md > README.md
+
+      - name: Lint README.md
+        run: npx awesome-lint README.md
+
       - name: Commit changes
+        if: success() # Only commit if linting passes
         uses: stefanzweifel/git-auto-commit-action@v4
         with:
           commit_message: 'Auto-update README.md [skip ci]'