👷 Add a lint workflow

.github/workflows/build.yml

@@ -1,12 +1,12 @@
 name: Build debian package
 
 on:
+  pull_request:
+    branches: [main]
   push:
-    branches:
-      - main
-
+    branches: [main]
   workflow_call:
-    
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -20,11 +20,11 @@ jobs:
       - name: Install toolchain
         uses: dtolnay/rust-toolchain@stable
 
+      - name: Cargo lint
+        run: cargo fmt --all -- --check
+
       - name: Cargo test
         run: cargo test
 
       - name: Cargo build
-        run: cargo build --release
-
-      - name: Create debian package
-        run: ./debian-build.sh
+        run: cargo build

.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+name: Lint
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+  workflow_call:
+
+jobs:
+  lint-markdown:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Lint markdown files
+        uses: avto-dev/[email protected]
+        with:
+          args: "**/*.md"
+
+  lint-yaml:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Lint yaml files
+        uses: ibiqlik/[email protected]

.github/workflows/release.yml

@@ -5,6 +5,8 @@ on:
     types: [created]
 
 jobs:
+  lint:
+    uses: ./.github/workflows/lint.yml
   build-ok:
     uses: ./.github/workflows/build.yml
 

.markdownlint.yaml

@@ -0,0 +1,2 @@
+line-length: false
+MD038: false

.yamllint.yaml

@@ -0,0 +1,6 @@
+extends: default
+rules:
+  document-start: disable
+  line-length:
+    max: 160
+    level: warning

README.md

@@ -52,10 +52,6 @@ Only tried on Pop!_OS 22.04 LTS. Should work on any Debian based distri with X11
 
 ## TODO
 
-- [x] uninstall should remove service
-- [x] config file for a debian package?
-- [x] man page
-- [ ] CI lint
 - [ ] debian package lint warnings
 - [ ] remove test from build script
 - [ ] readme badges rust & lint

debian-build.sh

@@ -29,8 +29,6 @@ echo "📝 Make man..."
 # docker run --rm -v $(pwd):/working -w /working pandoc/minimal:3 --to man man.md -o capslock-auto-switch.1
 gzip -c -n -9 ./capslock-auto-switch.1 > ./${DEBIAN_FOLDER}/usr/share/man/man1/capslock-auto-switch.1.gz
 
-echo "🧪 run tests..."
-cargo test
 echo "🦀 run build..."
 cargo build --release
 strip target/release/$BINARY_NAME