refactor(ci): use flake to draw SVGs

Author: MattSturgeon

.github/workflows/draw-keymaps.yml

@@ -4,12 +4,8 @@ on:
   push:               # automatically run on changes to following paths
     paths:
       - "**.lock"
+      - "drawer/**"
       - "config/**"
-env:
-  km_dr_version: main
-  km_dr_config: config/keymap_drawer.yaml
-  keymap_path: config/*.keymap
-  output_folder: img
 
 jobs:
   draw:
@@ -21,72 +17,21 @@ jobs:
     steps:
 
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 1 # Set to 2 if amending, or 1 if creating a new commit
+          # Set to 2 if amending, or 1 if creating a new commit
+          fetch-depth: 1
           submodules: recursive
 
-      - name: Install python dependencies
-        run: |
-          pip install "git+https://github.com/caksoylar/keymap-drawer.git@${{ env.km_dr_version }}"
-          pip install pyyaml
+      - name: Install nix
+        uses: cachix/install-nix-action@v25
+      - name: Setup nix cache
+        uses: DeterminateSystems/magic-nix-cache-action@main
 
-      # TODO get keyboads & configs dynamically
-      - name: Parse keymap
-        run: |
-          # TODO set generic vars in one place globally
-          CONFIG="${{ env.km_dr_config }}"
-
-          for KEYMAP in ${{ env.keymap_path }}; do
-            KEYBOARD=$(basename -s .keymap "$KEYMAP")
-            OUTPUT="${{ env.output_folder }}/${KEYBOARD}.yaml"
-
-            # TODO consider running through `parallel`?
-            echo "Parsing keymap for $KEYBOARD"
-            keymap -c "$CONFIG" parse -z "$KEYMAP" > "$OUTPUT"
-          done
-
-      - name: Draw keymap for all layers
-        run: |
-          CONFIG="${{ env.km_dr_config }}"
-
-          # FIXME can glob false positeves, e.g. previous keymaps
-          for KEYMAP in ${{ env.output_folder }}/*.yaml; do
-            KEYBOARD=$(basename -s .yaml "$KEYMAP")
-            OUTPUT="${{ env.output_folder }}/${KEYBOARD}.svg"
-
-            echo "Drawing all layers for $KEYBOARD"
-            keymap -c "$CONFIG" draw "$KEYMAP" > "$OUTPUT"
-          done
-
-
-      - name: Draw seperate layer keymaps
-        run: |
-          # Ensure errors propagate when piping stdout
-          set -o pipefail
-
-          export CONFIG="${{ env.km_dr_config }}"
-
-          # Function to draw the given layer's keymap
-          draw() {
-            KEYMAP="$1"
-            LAYER="$2"
-            KEYBOARD=$(basename -s .yaml "$KEYMAP")
-            OUTPUT="${{ env.output_folder }}/${KEYBOARD}_${LAYER}.svg"
-
-            echo "Drawing $LAYER layer for $KEYBOARD"
-            keymap -c "$CONFIG" draw "$KEYMAP" -s "$LAYER" > "$OUTPUT"
-          }
-          export -f draw # Ensure the draw function can be called by `parallel`'s subprocess
-
-          # FIXME can glob false positeves, e.g. previous keymaps
-          for KEYMAP in ${{ env.output_folder }}/*.yaml; do
-            # Run `draw()` for each layer in the keymap. Up to 4 layers at a time...
-            echo "Drawing layers in parallel"
-            python3 .github/workflows/layers.py "$KEYMAP" \
-            | parallel --jobs 4 draw "$KEYMAP"
-          done
+      - name: Draw keymaps
+        run: nix run . -- draw
 
+      # TODO print to $GITHUB_STEP_SUMMARY
       - name: Commit changes
         uses: stefanzweifel/git-auto-commit-action@v4
         with:

.github/workflows/layers.py

@@ -5,11 +5,15 @@
 }: let
 in {
     perSystem = {
+      config,
       pkgs,
       system,
       ...
     }: let
       inherit (inputs.poetry2nix.lib.mkPoetry2Nix {inherit pkgs;}) mkPoetryApplication;
+
+      exe = lib.getExe config.packages.keymap-drawer;
+      yq = lib.getExe pkgs.yq-go;
     in {
       packages = {
         keymap-drawer = mkPoetryApplication {
@@ -21,4 +25,42 @@ in {
           };
         };
     };
+
+      devshells.default.commands = [
+        {
+          name = "draw";
+          command = /*bash*/ ''
+            set +e
+
+            out="$PRJ_ROOT"/img
+            keymap_dir="$PRJ_ROOT"/config
+            cmd="${exe} --config $keymap_dir/keymap_drawer.yaml"
+
+            echo "Removing previous images"
+            rm "$out"/*
+
+            for file in "$keymap_dir"/*.keymap
+            do
+              name="$(basename --suffix=".keymap" "$file")"
+              config="$out/$name.yaml"
+              echo "Found keymap $name"
+
+              echo "- Parsing keymap-drawer"
+              $cmd  parse --zmk-keymap "$file" > "$config"
+
+              echo "- Drawing all layers"
+              $cmd draw "$config" > "$out"/"$name".svg
+
+              layers=$(${yq} '.layers | keys | .[]' "$config")
+              for layer in $layers
+              do
+                echo "- Drawing $layer layer"
+                $cmd draw "$config" --select-layers "$layer" > "$out"/"$name"_"$layer".svg
+              done
+            done
+          '';
+          help = "Draw SVG images of the keymap";
+        }
+      ];
+  };
 }