Merge pull request #12 from go-slog/auto-generate-readme

Auto generate readme

.github/workflows/ci.yaml

@@ -32,8 +32,8 @@ jobs:
       - name: Regenerate README
         run: nix develop --impure .#ci -c make generate
 
-      - name: Check diff
-        run: git diff --quiet README.md || (echo "Please run 'make generate' to regenerate README.md" && exit 1)
+      # - name: Check diff
+      #   run: git diff --quiet README.md || (echo "Please run 'make generate' to regenerate README.md" && exit 1)
 
   dev:
     name: Developer environment

.github/workflows/generate.yaml

@@ -0,0 +1,43 @@
+name: Generate
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  readme:
+    name: README.md
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+      - name: Set up Nix
+        uses: cachix/install-nix-action@7ac1ec25491415c381d9b62f0657c7a028df52a7 # v24
+        with:
+          extra_nix_config: |
+            access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up magic Nix cache
+        uses: DeterminateSystems/magic-nix-cache-action@8a218f9e264e9c3803c9a1ee1c30d8e4ab55be63 # v2
+
+      - name: Prepare Nix shell
+        run: nix develop --impure .#ci
+
+      - name: Regenerate README
+        run: nix develop --impure .#ci -c make generate
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: Regenerate README.md
+          file_pattern: README.md
+        if: github.event_name == 'push'

data.yaml

@@ -107,7 +107,7 @@ categories:
       - name: slog-parquet
         link: https://github.com/samber/slog-parquet
         description: Handler forwarding logs to an object store in parquet format.
-      
+
       - name: slog-pushover
         link: https://github.com/SkYNewZ/slog-pushover
         description: Handler forwarding logs to Pushover.
@@ -166,6 +166,10 @@ categories:
         link: https://github.com/FabienMht/ginslog
         description: A fully featured Gin middleware.
 
+      - name: slog-chi
+        link: https://github.com/samber/slog-chi
+        description: Chi middleware.
+
       - name: slog-echo
         link: https://github.com/samber/slog-echo
         description: Echo middleware.