Merge pull request #195 from Bastian-Krause/bst/1.4

Prepare for 1.4 release

Author: Bastian-Krause

CHANGES CHANGES.rstCHANGES renamed to CHANGES.rst

@@ -1,3 +1,59 @@
+Release 1.4 (released Jul 14, 2025)
+-----------------------------------
+
+.. rubric:: Enhancements
+
+* Add support for hawkBit "download-only" deployments. [#160] (by Vyacheslav
+  Yurkov)
+* Share connection between curl requests. [#170] (by Robin van der Gracht)
+* Add support for SSL client certificate authentication, see the new config
+  options ``ssl_cert``, ``ssl_key`` and ``ssl_engine``. [#169] (by Florian
+  Bezannier, Robin van der Gracht)
+* Add ``send_download_authentication`` option to allow disabling sending
+  authentication data for bundle downloads (needed if external storage
+  providers are used). [#174] (by Kevin Fardel)
+
+.. rubric:: Bug Fixes
+
+* Allow ``stream_bundle=true`` without setting ``bundle_download_location``.
+  [#150]
+
+.. rubric:: Testing
+
+* Add ``workflow_dispatch`` trigger allowing manually triggered CI runs. [#154]
+* Print subprocess's stdout/stderr on timeout errors for debugging purposes.
+  [#163] (by Vyacheslav Yurkov)
+* Add CodeQL workflow. [#167]
+* Add libcairo2-dev to test dependencies. [#182]
+* Bind hawkbit docker container and nginx to localhost only. [#185]
+* Drop hawkBit option ``anonymous.download.enabled`` removed in >= 0.8.0.
+  [#190]
+* Use hawkBit's ``server.forward-headers-strategy=NATIVE`` option allowing a
+  reverse proxy between rauc-hawkbit-updater and hawkBit. [#169] (by Robin van
+  der Gracht)
+* Add SSL client certificate authentication tests using nginx with a test PKI.
+  [#169] (by Robin van der Gracht)
+* Move nginx configs to dedicated files. [#188]
+* Make partial download tests more reliable with nginx lua scripting. [#188]
+* Fix non-root nginx execution in some rare cases. [#179] (by Thibaud Dufour)
+* Add test for ``send_download_authentication=false``. [#174] (by Kevin Fardel)
+
+.. rubric:: Documentation
+
+* Use correct ``stream_bundle`` configuration option in ``README.md``. [#145]
+  (by Lukas Reinecke)
+* Improve documentation of ``stream_bundle`` configuration option. [#146]
+* Update links to hawkBit documentation. [#164] (by Vyacheslav Yurkov)
+* Mention minimal build requirements. [#167]
+* Fix readthedocs builds. [#167], [#173]
+* Provide full-blown config in ``README.md`` and minimal one in the reference
+  documentation. [#195]
+
+.. rubric:: Build System
+
+* Lower ``warning_level`` to 2, because ``-Wpedantic`` is not supported for
+  compiling GLib-based code. [#182]
+
 Release 1.3 (released Oct 14, 2022)
 -----------------------------------
 

README.md

@@ -28,23 +28,27 @@ Setup target (device) configuration file:
 
 ```ini
   [client]
-  hawkbit_server            = 127.0.0.1:8080
-  ssl                       = false
-  ssl_verify                = false
-  tenant_id                 = DEFAULT
-  target_name               = test-target
-  auth_token                = bhVahL1Il1shie2aj2poojeChee6ahShu
-  #gateway_token            = bhVahL1Il1shie2aj2poojeChee6ahShu
-  #ssl_engine               = pkcs11
-  #ssl_key                  = pkcs11:token=mytoken;object=mykey
-  #ssl_cert                 = /path/to/certificate.pem
-  bundle_download_location  = /tmp/bundle.raucb
-  retry_wait                = 60
-  connect_timeout           = 20
-  timeout                   = 60
-  log_level                 = debug
-  post_update_reboot        = false
-  #stream_bundle            = true
+  hawkbit_server                = hawkbit.example.com
+  target_name                   = target-1234
+  auth_token                    = bhVahL1Il1shie2aj2poojeChee6ahShu
+  #gateway_token                = chietha8eiD8Ujaxerifoxoh6Aed1koof
+  #ssl_key                      = pkcs11:token=mytoken;object=mykey
+  #ssl_cert                     = /path/to/certificate.pem
+  bundle_download_location      = /tmp/bundle.raucb
+  #tenant_id                    = DEFAULT
+  #ssl                          = true
+  #ssl_verify                   = true
+  #ssl_engine                   = pkcs11
+  #connect_timeout              = 20
+  #timeout                      = 60
+  #retry_wait                   = 300
+  #low_speed_time               = 60
+  #low_speed_rate               = 100
+  #resume_downloads             = false
+  #stream_bundle                = false
+  #post_update_reboot           = false
+  #log_level                    = message
+  #send_download_authentication = true
 
   [device]
   product                   = Terminator

docs/changes.rst

@@ -5,4 +5,4 @@
 Changes in RAUC hawkBit Updater
 ===============================
 
-.. include:: ../CHANGES
+.. include:: ../CHANGES.rst

docs/conf.py

@@ -18,11 +18,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'RAUC hawkBit Updater'
-copyright = '2018-2022, Lasse Klok Mikkelsen, Enrico Jörns, Bastian Krause'
+copyright = '2018-2025, Lasse Klok Mikkelsen, Enrico Jörns, Bastian Krause'
 author = 'Lasse Klok Mikkelsen, Enrico Jörns, Bastian Krause'
 
 # The full version, including alpha/beta/rc tags
-release = '1.3'
+release = '1.4'
 
 
 # -- General configuration ---------------------------------------------------

docs/reference.rst

@@ -12,16 +12,13 @@ Reference
 Configuration File
 ------------------
 
-Example configuration:
+Minimal configuration example:
 
 .. code-block:: cfg
 
   [client]
-  hawkbit_server            = 127.0.0.1:8080
-  ssl                       = false
-  ssl_verify                = false
-  tenant_id                 = DEFAULT
-  target_name               = test-target
+  hawkbit_server            = hawkbit.example.com
+  target_name               = target-1234
   auth_token                = bhVahL1Il1shie2aj2poojeChee6ahShu
   bundle_download_location  = /tmp/bundle.raucb
 

docs/release-checklist.txt

@@ -5,13 +5,13 @@ Preparation
 -----------
 - check for GitHub milestone to be completed
   - review & merge open PRs if necessary
-- update CHANGES
+- update CHANGES.rst
 - update version in docs/conf.py and meson.build
 - create preparation PR, merge PR
 
 Release
 -------
-- update release date in CHANGES and commit
+- update release date in CHANGES.rst and commit
 - create signed git tag::
 
     git tag -m 'release v1.0' -s -u 925F79DAA74AF221 v1.0
@@ -35,6 +35,6 @@ Release
   - upload source archive and signature
   - add release text using CHANGES::
 
-      pandoc -f rst -t markdown_github CHANGES
+      pandoc -f rst -t markdown_github CHANGES.rst
 
   - Submit release button

meson.build

@@ -1,7 +1,7 @@
 project(
   'rauc-hawkbit-updater',
   'c',
-  version : '1.3',
+  version : '1.4',
   meson_version : '>=0.50',
   default_options: [
     'warning_level=2',

src/config-file.c

@@ -1,6 +1,6 @@
 /**
  * SPDX-License-Identifier: LGPL-2.1-only
- * SPDX-FileCopyrightText: 2021-2022 Bastian Krause <bst@pengutronix.de>, Pengutronix
+ * SPDX-FileCopyrightText: 2021-2025 Bastian Krause <bst@pengutronix.de>, Pengutronix
  * SPDX-FileCopyrightText: 2018-2020 Lasse K. Mikkelsen <lkmi@prevas.dk>, Prevas A/S (www.prevas.com)
  *
  * @file

src/hawkbit-client.c

@@ -1,6 +1,6 @@
 /**
  * SPDX-License-Identifier: LGPL-2.1-only
- * SPDX-FileCopyrightText: 2021-2022 Bastian Krause <bst@pengutronix.de>, Pengutronix
+ * SPDX-FileCopyrightText: 2021-2025 Bastian Krause <bst@pengutronix.de>, Pengutronix
  * SPDX-FileCopyrightText: 2018-2020 Lasse K. Mikkelsen <lkmi@prevas.dk>, Prevas A/S (www.prevas.com)
  *
  * @file

src/rauc-hawkbit-updater.c

@@ -1,6 +1,6 @@
 /**
  * SPDX-License-Identifier: LGPL-2.1-only
- * SPDX-FileCopyrightText: 2021-2022 Bastian Krause <bst@pengutronix.de>, Pengutronix
+ * SPDX-FileCopyrightText: 2021-2025 Bastian Krause <bst@pengutronix.de>, Pengutronix
  * SPDX-FileCopyrightText: 2018-2020 Lasse K. Mikkelsen <lkmi@prevas.dk>, Prevas A/S (www.prevas.com)
  *
  * @file