[Diff][Added] tag_filter

- To select which tags are used for KIBOT_TAG

Author: set-soft

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - CLI:
   - --keep-temporals: to keep temporal files
+- Diff:
+  - `tag_filter`: to select which tags are used for KIBOT_TAG
 
 
 ## [1.9.0] - 2026-05-12

docs/samples/generic_plot.kibot.yaml

@@ -1126,6 +1126,7 @@ outputs:
       # changes in the history you want to go back. A 0 is the same as `HEAD`,
       # a 1 means the last time the PCB/SCH was changed, etc.
       # Use `KIBOT_TAG-n` to search for the last tag skipping `n` tags.
+      # The tags can be filtered using `tag_filter` option.
       # Important: when using the `checkout` GitHub action you just get the
       # last commit. To clone the full repo use `fetch-depth: '0'`
       old: 'HEAD'
@@ -1148,6 +1149,8 @@ outputs:
       # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the
       # variant
       pre_transform: '_null'
+      # [string=''] A regular expression used to match the used tags for `KIBOT_TAG`
+      tag_filter: ''
       # [number=0] [0,1000000] Error threshold for the `stats` mode, 0 is no error. When specified a
       # difference bigger than the indicated value will make the diff fail.
       # KiBot will return error level 29 and the diff generation will be aborted

docs/source/Changelog.rst

@@ -23,6 +23,10 @@ Added
 
    -  –keep-temporals: to keep temporal files
 
+-  Diff:
+
+   -  ``tag_filter``: to select which tags are used for KIBOT_TAG
+
 [1.9.0] - 2026-05-12
 --------------------
 

docs/source/configuration/outputs/DiffOptions.rst

@@ -56,6 +56,7 @@ DiffOptions parameters
    changes in the history you want to go back. A 0 is the same as `HEAD`,
    a 1 means the last time the PCB/SCH was changed, etc. |br|
    Use `KIBOT_TAG-n` to search for the last tag skipping `n` tags. |br|
+   The tags can be filtered using `tag_filter` option. |br|
 
 .. note::
       when using the `checkout` GitHub action you just get the
@@ -79,6 +80,7 @@ DiffOptions parameters
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the
    variant.
 
+-  ``tag_filter`` :index:`: <pair: output - diff - options; tag_filter>` [:ref:`string <string>`] (default: ``''``) A regular expression used to match the used tags for `KIBOT_TAG`.
 -  ``threshold`` :index:`: <pair: output - diff - options; threshold>` [:ref:`number <number>`] (default: ``0``) (range: 0 to 1000000) Error threshold for the `stats` mode, 0 is no error. When specified a
    difference bigger than the indicated value will make the diff fail. |br|
    KiBot will return error level 29 and the diff generation will be aborted.

kibot/out_diff.py

@@ -54,6 +54,7 @@ def __init__(self):
                 changes in the history you want to go back. A 0 is the same as `HEAD`,
                 a 1 means the last time the PCB/SCH was changed, etc.
                 Use `KIBOT_TAG-n` to search for the last tag skipping `n` tags.
+                The tags can be filtered using `tag_filter` option.
                 Important: when using the `checkout` GitHub action you just get the
                 last commit. To clone the full repo use `fetch-depth: '0'` """
             self.old_type = 'git'
@@ -117,6 +118,8 @@ def __init__(self):
             """ Color used for the added stuff in the '2color' mode """
             self.color_removed = '#FF0000'
             """ Color used for the removed stuff in the '2color' mode """
+            self.tag_filter = ''
+            """ A regular expression used to match the used tags for `KIBOT_TAG` """
         super().__init__()
         self.add_to_doc("zones", "Be careful with the cache when changing this setting")
 
@@ -133,6 +136,10 @@ def config(self, parent):
         if self.old_type == 'multivar' and self.new_type != 'multivar':
             raise KiPlotConfigurationError("`old_type` can't be `multivar` when `new_type` isn't (`{}`)".format(self.new_type))
         self.validate_colors(['color_added', 'color_removed'])
+        try:
+            self._tag_filter = re.compile(self.tag_filter)
+        except Exception as e:
+            raise KiPlotConfigurationError('Invalid regular expression '+str(e))
 
     def get_targets(self, out_dir):
         return [self._parent.expand_filename(out_dir, self.output)]
@@ -235,8 +242,11 @@ def process_tags(self, num):
         skipped = 0
         for v in res:
             try:
-                tag = v[v.index('tag: '):].split(',')[0][4:]
-                logger.debugl(2, '- {}/{} tag: {} -> {}'.format(skipped, num, tag, commit))
+                tag = v[v.index('tag: '):].split(',')[0][5:]
+                matches = self._tag_filter.search(tag) is not None if self.tag_filter else True
+                logger.debugl(2, f'- {skipped}/{num} / matches filter: {matches} - tag: `{tag}` -> {commit}')
+                if not matches:
+                    continue
                 if skipped == num:
                     return commit
                 skipped += 1

tests/GUI/outputs

@@ -2657,6 +2657,13 @@
           ],
           null
         ],
+        [
+          "tag_filter",
+          [
+            "DataTypeString"
+          ],
+          null
+        ],
         [
           "zones",
           [

tests/GUI/stats

@@ -1,5 +1,5 @@
-56 outputs types with a total of 2235 different parameters
-Single type parameters: 2046 (92 %)
+56 outputs types with a total of 2236 different parameters
+Single type parameters: 2047 (92 %)
 Multi type parameters: 189 (8 %)
 Average parameters: 40
 Maximum number of parameters: 218
@@ -67,7 +67,7 @@ Outputs sorted by parameters:
 - pcb2blender_tools: 34
 - vrml: 34
 - kicost: 37
-- diff: 41
+- diff: 42
 - excellon: 42
 - export_3d: 42
 - dxf: 43
@@ -153,7 +153,7 @@ Outputs sorted by depth:
 - bom: 5
 --------------------------------------------------------------------------------
 14 different data types
--             String:  972
+-             String:  973
 -            Boolean:  562
 - ListStringSingular:  303
 -             Number:  303
@@ -169,7 +169,7 @@ Outputs sorted by depth:
 -       NumberChoice:    1
 --------------------------------------------------------------------------------
 Used as single data type:
--             String:  805 
+-             String:  806 
 -            Boolean:  494 
 - ListStringSingular:  300 
 -             Number:  209 
@@ -414,8 +414,8 @@ Used as single data type:
 -              Number,String:   15 
 ================================================================================
 ================================================================================
-97 totals types with a total of 2633 different parameters
-Single type parameters: 2418 (92 %)
+97 totals types with a total of 2634 different parameters
+Single type parameters: 2419 (92 %)
 Multi type parameters: 215 (8 %)
 Average parameters: 27
 Maximum number of parameters: 218
@@ -524,7 +524,7 @@ Totals sorted by parameters:
 - vrml: 34
 - generic: 35
 - kicost: 37
-- diff: 41
+- diff: 42
 - excellon: 42
 - export_3d: 42
 - dxf: 43
@@ -651,7 +651,7 @@ Totals sorted by depth:
 - bom: 5
 --------------------------------------------------------------------------------
 14 different data types
--             String: 1141
+-             String: 1142
 -            Boolean:  665
 -             Number:  356
 - ListStringSingular:  333
@@ -667,7 +667,7 @@ Totals sorted by depth:
 -       NumberChoice:    1
 --------------------------------------------------------------------------------
 Used as single data type:
--             String:  956 
+-             String:  957 
 -            Boolean:  587 
 - ListStringSingular:  330 
 -             Number:  247