Merge pull request #10 from Supermanuu/na/drc-check

N/A: updated kibot and added drc check

.github/workflows/release.yml

@@ -32,9 +32,7 @@ jobs:
           GIT_VERSION_STRING: ${{ steps.tag.outputs.new_tag }}
 
       - name: Generate gerbers, schema, images...
-        uses: INTI-CMNB/KiBot@v1.7.0
-        env:
-          KICAD_3RD_PARTY: ${GITHUB_WORKSPACE}/3rdparty/
+        run: docker compose run --rm kibot
 
       - name: Inspect project files
         run: ls -l . release Gerbers

.gitignore

@@ -41,3 +41,7 @@ _doc
 3d.step
 manufacturing.zip
 BatterySwitcher-erc.txt
+BatterySwitcher-erc.html
+BatterySwitcher-drc.txt
+BatterySwitcher-drc.html
+kibot_*.kicad_*

README.md

@@ -4,9 +4,9 @@
 [![CI pipeline list](https://github.com/Supermanuu/BatterySwitcher/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/Supermanuu/BatterySwitcher/actions/workflows/release.yml)
 [![link to latest version](https://img.shields.io/badge/version-latest-blue)](https://github.com/Supermanuu/BatterySwitcher/releases/latest)
 
-We are triying yo make a battery switch for the Sofle Keyboard, or properly said, the [nRFMicro](https://github.com/joric/nrfmicro/tree/1.4) board used by the [Sofle](https://github.com/josefadamcik/SofleKeyboard) Keyboard.
+We are triying to make a battery switch for the Sofle Keyboard, or properly said, the [nRFMicro](https://github.com/joric/nrfmicro/tree/1.4) board used by the [Sofle](https://github.com/josefadamcik/SofleKeyboard) Keyboard.
 
-Our goal is to have a PCB that could short and open the baterry supply via a switch, keeping as low profile as possible and doing it as integrated as possible
+Our goal is to have a PCB that could short and open the baterry supply via a switch, keeping as low profile as possible and doing it as integrated as possible. Also, the device should change the battery in any of the positions, because the `nRFMicro` has a battery charge monitor.
 
 ## Setup
 
@@ -32,17 +32,18 @@ See [Github releases](https://github.com/Supermanuu/BatterySwitcher/releases).
 
 Each release has:
 
-* iBOM in `ibom.html`
-* Schematic in `schematic.pdf`
-* User guide in `user-guide.html`
+* User guide in `user-guide.html`, with a lot of information to build the PCB.
+* iBOM in `ibom.html`, with all the PCB parts.
+* Another BOM in `out-of-bom.html`, with parts not used by the PCB, but needed in some cases.
+* Schematic in `schematic.pdf`, with the diagram of the PCB.
 * PCB images:
   * top view in `top.png`.
   * bottom view in `bottom.png`.
 
 Another attach has:
 
 * Gerber files and drill files in `manufacturing.zip`
-* Pick and place file, JLC style in `pick_and_place.csv`
+* 3D model in `3D.step`
 
 ## Generate release
 

config.kibot.yaml

@@ -1,4 +1,5 @@
-# Example KiPlot config file
+# Doc: https://kibot.readthedocs.io/en/master/introduction.html
+
 kiplot:
   version: 1
 
@@ -27,9 +28,12 @@ filters:
         regex: 'mount.*hole'
 
 preflight:
-  run_erc: true
+  erc:
+    enabled: true
+  drc:
+    all_track_errors: true
+    dont_stop: true
   update_xml: true
-  # run_drc: true
   check_zone_fills: false
   ignore_unconnected: false
 

docker-compose.yml

@@ -11,14 +11,17 @@ services:
       - ./:/data/
     command: markdown-folder-to-html /data/doc
   kibot:
-    image: ghcr.io/inti-cmnb/kicad8_auto:1.6.5
+    image: ghcr.io/inti-cmnb/kicad8_auto:latest # All versions: https://kibot.readthedocs.io/en/master/usage_with_ci_cd.html
     working_dir: /data
     volumes:
       - ./:/data/
     environment:
       # NO_AT_BRIDGE: 1 # Think is not needed
       KICAD_3RD_PARTY: /data/3rdparty/
-    command: kibot
+    command: |
+      bash -c "
+        CLICOLOR_FORCE=1 kibot 2>&1 | sed 's/WARNING/::warning :/g' | sed 's/ERROR/::error :/g'
+      "
   version:
     image: git-and-bash
     build: 
@@ -32,7 +35,7 @@ services:
       bash -c '
         set -e -o pipefail 
         VERSIONED_FILES="BatterySwitcher.kicad_pcb BatterySwitcher.kicad_sch"
-        if [ -z "$GIT_VERSION_STRING" ]; then
+        if [ -z "$$GIT_VERSION_STRING" ]; then
           echo GIT_VERSION_STRING env variable has not been setted
           exit 1
         fi