bump version 1.1.3

vortigont · Jan 25, 2024 · fc357fe · fc357fe
1 parent c813a48
commit fc357fe
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 13 deletions.
diff --git a/.github/workflows/pio_build.yml b/.github/workflows/pio_build.yml
@@ -7,13 +7,12 @@ name: PlatformIO CI
 on:
   push:
 #    branches: [ main, feat ]
-    paths:                                                                                                                                                    
-    - '**.ino'                                                                                                                                                
-    - '**.cpp'                                                                                                                                                
-    - '**.hpp'                                                                                                                                                
-    - '**.h'                                                                                                                                                  
-    - '**.c'                                                                                                                                                  
-    - '**.ini'                                                                                                                                                
+    paths:
+    - '**.cpp'
+    - '**.hpp'
+    - '**.h'
+    - '**.c'
+    - '**.ini'
     - '**.yml'
   pull_request:
     branches: [ main ]
@@ -31,7 +30,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Cache pip
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ~/.cache/pip
         key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Change Log
 
+## v 1.1.3 (2024-01-26)
+ + example for on-the-fly compression via pako.js lib
+ * make exaples more CI friendly
+ * minor cleanup
+
 ## v 1.1.2 (2023-05-20)
  + add `FZ_NOHTTPCLIENT` build-time flag to exclude HTTP Client support for the sake of reduced binary size
  * more safety for dynamic objects

diff --git a/README.md b/README.md
@@ -1,9 +1,10 @@
 ESP32-FlashZ
-an arduino library that provides zlib compressed OTA update feature for esp32
 ======
 
-__[EXAMPLES](/examples/README.md) | [CHANGELOG](/CHANGELOG.md) |__ [![PlatformIO
- CI](https://github.com/vortigont/esp32-flashz/actions/workflows/pio_build.yml/badge.svg)](https://github.com/vortigont/esp32-flashz/actions/workflows/pio_build.yml)
+### an arduino library that provides zlib compressed OTA update feature for esp32
+
+__[EXAMPLES](/examples/README.md) | [CHANGELOG](/CHANGELOG.md) | [![PlatformIO
+ CI](https://github.com/vortigont/esp32-flashz/actions/workflows/pio_build.yml/badge.svg)](https://github.com/vortigont/esp32-flashz/actions/workflows/pio_build.yml) | [![PlatformIO Registry](https://badges.registry.platformio.org/packages/vortigont/library/esp32-flashz.svg)](https://registry.platformio.org/libraries/vortigont/esp32-flashz) |__
 
 
 Unlike [esp8266](https://github.com/esp8266/Arduino/pull/6820/commits/67ba90d3eaf01c5400d0b42cdce05ef9295d8c16), esp32's bootloader does not (yet) support compressed image updates. But esp32 has a miniz lib decompressor in ROM, so it can be used to decompress zlib packed stream on the fly during OTA update and write decompressed data to SPI flash. This could be done both for firmware and filesystem image.

diff --git a/library.json b/library.json
@@ -2,7 +2,7 @@
     "name": "esp32-flashz",
     "frameworks": "arduino",
     "platforms": ["espressif32"],
-    "version": "1.1.2",
+    "version": "1.1.3",
     "keywords": "ota, zlib, esp32",
     "description": "ESP32-FlashZ - an arduino library that provides zlib compressed OTA update feature for esp32",
     "url": "https://github.com/vortigont/esp32-flashz",

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=esp32-flashz
-version=1.1.2
+version=1.1.3
 author=Emil Muratov
 maintainer=Emil Muratov
 sentence=ESP32-FlashZ arduino library