From d6ede99b6367de94f3d239f7486f49713a40d5bb Mon Sep 17 00:00:00 2001
From: ibizaman <ibizapeanut@gmail.com>
Date: Wed, 29 May 2024 14:27:43 -0700
Subject: [PATCH] add to the changelog

---
 CHANGELOG.md | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index f7d8d7f..1001dc4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,9 +1,40 @@
-# Upcoming
+# Upcoming Release
 
+## Breaking Changes
+
+- Rename `shb.nginx.autheliaProtect` to `shb.nginx.vhosts`. Indeed, the option allows to define a vhost with _optional_ Authelia protection but the former name made it look like Authelia protection was enforced.
+- Remove `shb.vaultwarden.ldapEndpoint` option because it was not used in the implementation anyway.
+
+## User Facing Backwards Compatible Changes
+
+- Fix home-assistant onboarding file generation. Added new VM test.
+- OIDC and SMTP config are now optional in Vaultwarden. Added new VM test.
+- Add default OIDC config for Authelia. This way, Authelia can start even with no config or only forward auth configs.
+- Fix replaceSecrets function. It wasn't working correctly with functions from `lib.generators` and `pkgs.pkgs-lib.formats`. Also more test coverage.
+- Add udev extra rules to allow smartctl Prometheus exporter to find NVMe drives.
 - Revert Loki to major version 2 because upgrading to version 3 required manual intervention as Loki
   refuses to start. So until this issue is tackled, reverting is the best immediate fix.
   See https://github.com/NixOS/nixpkgs/commit/8f95320f39d7e4e4a29ee70b8718974295a619f4
 
+## Other Changes
+
+- Add pretty printing of test errors. Instead of:
+  ```
+  error: testRadarr failed: expected {"services":{"bazarr":{},"jackett":{},"lidarr":{},"nginx":{"enable":true},"radarr":{"dataDir":"/var/lib/radarr","enable":true,"group":"radarr","user":"radarr"},"readarr":{},"sonarr":{}},"shb":{"backup":{"instances":{"radarr":{"excludePatterns":[".db-shm",".db-wal",".mono"],"sourceDirectories":["/var/lib/radarr"]}}},"nginx":{"autheliaProtect":[{"authEndpoint":"https://oidc.example.com","autheliaRules":[{"domain":"radarr.example.com","policy":"bypass","resources":["^/api.*"]},{"domain":"radarr.example.com","policy":"two_factor","subject":["group:arr_user"]}],"domain":"example.com","ssl":null,"subdomain":"radarr","upstream":"http://127.0.0.1:7878"}]}},"systemd":{"services":{"radarr":{"serviceConfig":{"StateDirectoryMode":"0750","UMask":"0027"}}},"tmpfiles":{"rules":["d '/var/lib/radarr' 0750 radarr radarr - -"]}},"users":{"groups":{"radarr":{"members":["backup"]}}}}, but got {"services":{"bazarr":{},"jackett":{},"lidarr":{},"nginx":{"enable":true},"radarr":{"dataDir":"/var/lib/radarr","enable":true,"group":"radarr","user":"radarr"},"readarr":{},"sonarr":{}},"shb":{"backup":{"instances":{"radarr":{"excludePatterns":[".db-shm",".db-wal",".mono"],"sourceDirectories":["/var/lib/radarr"]}}},"nginx":{"vhosts":[{"authEndpoint":"https://oidc.example.com","autheliaRules":[{"domain":"radarr.example.com","policy":"bypass","resources":["^/api.*"]},{"domain":"radarr.example.com","policy":"two_factor","subject":["group:arr_user"]}],"domain":"example.com","ssl":null,"subdomain":"radarr","upstream":"http://127.0.0.1:7878"}]}},"systemd":{"services":{"radarr":{"serviceConfig":{"StateDirectoryMode":"0750","UMask":"0027"}}},"tmpfiles":{"rules":["d '/var/lib/radarr' 0750 radarr radarr - -"]}},"users":{"groups":{"radarr":{"members":["backup"]}}}}
+  ```
+  You now see:
+  ```
+  error: testRadarr failed (- expected, + result)
+   {
+     "dictionary_item_added": [
+       "root['shb']['nginx']['vhosts']"
+     ],
+     "dictionary_item_removed": [
+       "root['shb']['nginx']['authEndpoint']"
+     ]
+   }
+  ```
+
 # 0.1.0
 
 Creation of CHANGELOG.md