add spellcheck action (#34)

Author: hilmarf

.github/config/cspell.json

@@ -0,0 +1,15 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "words": [],
+  "dictionaries": [
+    "custom-words"
+  ],
+  "dictionaryDefinitions": [
+    {
+      "name": "custom-words",
+      "path": "./dictionary.txt",
+      "addWords": true
+    }
+  ]
+}

.github/config/dictionary.txt

@@ -0,0 +1,4 @@
+apeirora
+configurator
+flagd
+okhttp

.github/workflows/recommendation.yaml

@@ -18,12 +18,12 @@ jobs:
       packages: write
     steps:
       - name: Install Task
-        uses: arduino/setup-task@b91d5d2c96a56797b48ac1e0e89220bf64044611 # v2
+        uses: arduino/setup-task@24c5e13bce349197642746563945fcdf9355e8f4 # v2.0.0
         with:
           version: 3.x
           repo-token: ${{ secrets.GITHUB_TOKEN }}
       - name: Checkout Code
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Build `recommendation` image
         run: task recommendation:build
       - name: Login to GitHub Container Registry

.github/workflows/spellcheck.yaml

@@ -0,0 +1,20 @@
+name: Spell Check
+
+on:
+  pull_request:
+  push:
+    branches: [ main ]
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Check spelling
+        uses: streetsidesoftware/cspell-action@69543c3f9f14d4fcc6004c7bee03c4d366f11d64 # v7.0.1
+        with:
+          suggestions: true
+          incremental_files_only: ${{ github.event_name == 'pull_request' }}
+          # files: '**/*.{md,txt,js,ts,java,go,py,html,css,yaml,yml}'
+          files: '**/*.{md,txt,html}'
+          config: .github/config/cspell.json

README.md

@@ -32,8 +32,8 @@ task otel:port-forward
 ```bash
 brew install go-task/tap/go-task
 git clone https://github.com/apeirora/otel-audit-log-poc.git
-cd audit-logpoc-for-otel
-task # run the app 
+cd audit-log-poc-for-otel
+task # run the app
 task otel:port-forward #check http://localhost:8080
 #to stop port forwarding type ctrl + c in the terminal
 ```