feat(pre-commit): support to check file versions

esp-arduino-libs · Jun 1, 2024 · 9cdc53e · 9cdc53e
1 parent ec4efdc
commit 9cdc53e
Show file tree

Hide file tree

Showing 26 changed files with 357 additions and 160 deletions.
diff --git a/.github/scripts/check_versions.sh → .github/scripts/check_lib_versions.sh b/.github/scripts/check_versions.sh → .github/scripts/check_lib_versions.sh
diff --git a/.github/workflows/check_versions.yml → .github/workflows/check_lib_versions.yml b/.github/workflows/check_versions.yml → .github/workflows/check_lib_versions.yml
@@ -1,4 +1,4 @@
-name: Check Versions
+name: Check Library Versions
 
 on:
   pull_request:
@@ -26,5 +26,5 @@ jobs:
             echo "prerelease: ${{ steps.last_release.outputs.prerelease }}"
             echo "url: ${{ steps.last_release.outputs.url }}"
         - name: Check & Compare versions
-          run: bash ./.github/scripts/check_versions.sh ${{ steps.last_release.outputs.tag_name }}
+          run: bash ./.github/scripts/check_lib_versions.sh ${{ steps.last_release.outputs.tag_name }}
 
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -39,6 +39,14 @@ repos:
     hooks:
       - id: sync-conf-files
         name: Update when configuration files change
-        entry: python .github/ci/sync_conf_files.py ./
+        entry: python tools/sync_conf_files.py ./
         language: system
         files: '.*ESP_Panel_(Board_Custom|Board_Supported|Conf)\.h'
+
+  - repo: local
+    hooks:
+      - id: check-file-versions
+        name: Update when versions change
+        entry: python tools/check_file_version.py ./
+        language: system
+        files: '(.*ESP_Panel_(Board_Custom|Board_Supported|Conf)\.h|library.properties|.*ESP_PanelVersions.h)'
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,12 @@
 # ChangeLog
 
-## v0.1.2 - 2024-05-27
+## v0.1.2 - 2024-06-01
 
 ### Enhancements:
 
 * feat(config): add version control for all configuration files by @lzw655 (#32)
+* feat(touch): add i2c st1633 by @lzw655 (#22)
+* feat(pre-commit): support to check file versions
 
 ### Bugfixes:
 

diff --git a/ESP_Panel_Board_Custom.h b/ESP_Panel_Board_Custom.h
@@ -362,7 +362,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif /* ESP_PANEL_USE_CUSTOM_BOARD */
 

diff --git a/ESP_Panel_Conf.h b/ESP_Panel_Conf.h
@@ -6,28 +6,27 @@
 
 #pragma once
 
-/**
- * Debug configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////// Debug Configurations /////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Set to 1 if assert on error. Otherwise print error message */
 #define ESP_PANEL_CHECK_RESULT_ASSERT       (0)         // 0/1
 
 /* Set to 1 if print log message for debug */
 #define ESP_PANEL_ENABLE_LOG                (0)         // 0/1
 
-/**
- * Touch driver configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////// Touch Driver Configurations //////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Maximum point number */
 #define ESP_PANEL_TOUCH_MAX_POINTS          (5)
-
 /* Maximum button number */
 #define ESP_PANEL_TOUCH_MAX_BUTTONS         (1)
 
-/* Model configurations */
-// XPT2046
+/**
+ * XPT2046 related
+ *
+ */
 #define ESP_PANEL_TOUCH_XPT2046_Z_THRESHOLD             (400)   // Minimum Z pressure threshold
 /**
  * Enable Interrupt (PENIRQ) output, also called Full Power Mode.
@@ -59,6 +58,9 @@
  */
 #define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING          (0)     // 0/1
 
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/////////////////////////////////////////////// File Version ///////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
@@ -72,4 +74,4 @@
  */
 #define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
-#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0
+#define ESP_PANEL_CONF_FILE_VERSION_PATCH 1
diff --git a/examples/LCD/3wireSPI_RGB/ESP_Panel_Conf.h b/examples/LCD/3wireSPI_RGB/ESP_Panel_Conf.h
@@ -6,28 +6,27 @@
 
 #pragma once
 
-/**
- * Debug configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////// Debug Configurations /////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Set to 1 if assert on error. Otherwise print error message */
 #define ESP_PANEL_CHECK_RESULT_ASSERT       (0)         // 0/1
 
 /* Set to 1 if print log message for debug */
 #define ESP_PANEL_ENABLE_LOG                (0)         // 0/1
 
-/**
- * Touch driver configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////// Touch Driver Configurations //////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Maximum point number */
 #define ESP_PANEL_TOUCH_MAX_POINTS          (5)
-
 /* Maximum button number */
 #define ESP_PANEL_TOUCH_MAX_BUTTONS         (1)
 
-/* Model configurations */
-// XPT2046
+/**
+ * XPT2046 related
+ *
+ */
 #define ESP_PANEL_TOUCH_XPT2046_Z_THRESHOLD             (400)   // Minimum Z pressure threshold
 /**
  * Enable Interrupt (PENIRQ) output, also called Full Power Mode.
@@ -59,6 +58,9 @@
  */
 #define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING          (0)     // 0/1
 
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/////////////////////////////////////////////// File Version ///////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
@@ -72,4 +74,4 @@
  */
 #define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
-#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0
+#define ESP_PANEL_CONF_FILE_VERSION_PATCH 1
diff --git a/examples/LCD/QSPI/ESP_Panel_Conf.h b/examples/LCD/QSPI/ESP_Panel_Conf.h
@@ -6,28 +6,27 @@
 
 #pragma once
 
-/**
- * Debug configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////// Debug Configurations /////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Set to 1 if assert on error. Otherwise print error message */
 #define ESP_PANEL_CHECK_RESULT_ASSERT       (0)         // 0/1
 
 /* Set to 1 if print log message for debug */
 #define ESP_PANEL_ENABLE_LOG                (0)         // 0/1
 
-/**
- * Touch driver configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////// Touch Driver Configurations //////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Maximum point number */
 #define ESP_PANEL_TOUCH_MAX_POINTS          (5)
-
 /* Maximum button number */
 #define ESP_PANEL_TOUCH_MAX_BUTTONS         (1)
 
-/* Model configurations */
-// XPT2046
+/**
+ * XPT2046 related
+ *
+ */
 #define ESP_PANEL_TOUCH_XPT2046_Z_THRESHOLD             (400)   // Minimum Z pressure threshold
 /**
  * Enable Interrupt (PENIRQ) output, also called Full Power Mode.
@@ -59,6 +58,9 @@
  */
 #define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING          (0)     // 0/1
 
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/////////////////////////////////////////////// File Version ///////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
@@ -72,4 +74,4 @@
  */
 #define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
-#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0
+#define ESP_PANEL_CONF_FILE_VERSION_PATCH 1
diff --git a/examples/LCD/RGB/ESP_Panel_Conf.h b/examples/LCD/RGB/ESP_Panel_Conf.h
@@ -6,28 +6,27 @@
 
 #pragma once
 
-/**
- * Debug configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////// Debug Configurations /////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Set to 1 if assert on error. Otherwise print error message */
 #define ESP_PANEL_CHECK_RESULT_ASSERT       (0)         // 0/1
 
 /* Set to 1 if print log message for debug */
 #define ESP_PANEL_ENABLE_LOG                (0)         // 0/1
 
-/**
- * Touch driver configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////// Touch Driver Configurations //////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Maximum point number */
 #define ESP_PANEL_TOUCH_MAX_POINTS          (5)
-
 /* Maximum button number */
 #define ESP_PANEL_TOUCH_MAX_BUTTONS         (1)
 
-/* Model configurations */
-// XPT2046
+/**
+ * XPT2046 related
+ *
+ */
 #define ESP_PANEL_TOUCH_XPT2046_Z_THRESHOLD             (400)   // Minimum Z pressure threshold
 /**
  * Enable Interrupt (PENIRQ) output, also called Full Power Mode.
@@ -59,6 +58,9 @@
  */
 #define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING          (0)     // 0/1
 
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/////////////////////////////////////////////// File Version ///////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
@@ -72,4 +74,4 @@
  */
 #define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
-#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0
+#define ESP_PANEL_CONF_FILE_VERSION_PATCH 1
diff --git a/examples/LCD/SPI/ESP_Panel_Conf.h b/examples/LCD/SPI/ESP_Panel_Conf.h
@@ -6,28 +6,27 @@
 
 #pragma once
 
-/**
- * Debug configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////// Debug Configurations /////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Set to 1 if assert on error. Otherwise print error message */
 #define ESP_PANEL_CHECK_RESULT_ASSERT       (0)         // 0/1
 
 /* Set to 1 if print log message for debug */
 #define ESP_PANEL_ENABLE_LOG                (0)         // 0/1
 
-/**
- * Touch driver configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////// Touch Driver Configurations //////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Maximum point number */
 #define ESP_PANEL_TOUCH_MAX_POINTS          (5)
-
 /* Maximum button number */
 #define ESP_PANEL_TOUCH_MAX_BUTTONS         (1)
 
-/* Model configurations */
-// XPT2046
+/**
+ * XPT2046 related
+ *
+ */
 #define ESP_PANEL_TOUCH_XPT2046_Z_THRESHOLD             (400)   // Minimum Z pressure threshold
 /**
  * Enable Interrupt (PENIRQ) output, also called Full Power Mode.
@@ -59,6 +58,9 @@
  */
 #define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING          (0)     // 0/1
 
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/////////////////////////////////////////////// File Version ///////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
@@ -72,4 +74,4 @@
  */
 #define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
-#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0
+#define ESP_PANEL_CONF_FILE_VERSION_PATCH 1
diff --git a/examples/LVGL/v8/Porting/ESP_Panel_Board_Custom.h b/examples/LVGL/v8/Porting/ESP_Panel_Board_Custom.h
@@ -362,7 +362,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif /* ESP_PANEL_USE_CUSTOM_BOARD */
 

diff --git a/examples/LVGL/v8/Porting/ESP_Panel_Conf.h b/examples/LVGL/v8/Porting/ESP_Panel_Conf.h
@@ -6,28 +6,27 @@
 
 #pragma once
 
-/**
- * Debug configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////// Debug Configurations /////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Set to 1 if assert on error. Otherwise print error message */
 #define ESP_PANEL_CHECK_RESULT_ASSERT       (0)         // 0/1
 
 /* Set to 1 if print log message for debug */
 #define ESP_PANEL_ENABLE_LOG                (0)         // 0/1
 
-/**
- * Touch driver configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////// Touch Driver Configurations //////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Maximum point number */
 #define ESP_PANEL_TOUCH_MAX_POINTS          (5)
-
 /* Maximum button number */
 #define ESP_PANEL_TOUCH_MAX_BUTTONS         (1)
 
-/* Model configurations */
-// XPT2046
+/**
+ * XPT2046 related
+ *
+ */
 #define ESP_PANEL_TOUCH_XPT2046_Z_THRESHOLD             (400)   // Minimum Z pressure threshold
 /**
  * Enable Interrupt (PENIRQ) output, also called Full Power Mode.
@@ -59,6 +58,9 @@
  */
 #define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING          (0)     // 0/1
 
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/////////////////////////////////////////////// File Version ///////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Custom.h` in the library. The detailed rules are as follows:
@@ -72,4 +74,4 @@
  */
 #define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
-#define ESP_PANEL_CONF_FILE_VERSION_PATCH 0
+#define ESP_PANEL_CONF_FILE_VERSION_PATCH 1
diff --git a/examples/LVGL/v8/Rotation/ESP_Panel_Board_Custom.h b/examples/LVGL/v8/Rotation/ESP_Panel_Board_Custom.h
@@ -362,7 +362,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif /* ESP_PANEL_USE_CUSTOM_BOARD */