wip

Author: 0xClandestine

.github/workflows/checks.yml

@@ -12,6 +12,30 @@ env:
   CLICOLOR: 1
 
 jobs:
+  natspec:
+    name: Natspec Linting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@ec9f2d5744a09debf3a187a3f4f675c53b671911 # v2.13.0
+        with:
+          egress-policy: block
+          allowed-endpoints: >
+            github.com:443
+            release-assets.githubusercontent.com:443
+            objects.githubusercontent.com:443
+            raw.githubusercontent.com:443
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      - name: Run Natspec Lint
+        uses: beeb/lintspec@fd5b71ffc838f63f81caf3e85e90760d124efac2 # v0.4.1
+        with:
+          working-directory: "./"
+          paths: "[./src/contracts/]" # Only lint src/contracts/
+          exclude: "[]"
+          extra-args: "" # TODO: Config
+          version: "latest"
+          fail-on-problem: "true"
+
   typos:
     name: Typo Linting
     runs-on: ubuntu-latest