Add migration note to changelog

haskell · Jun 30, 2024 · 972f693 · 972f693
1 parent cf7688c
commit 972f693
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,7 +1,15 @@
 # CHANGELOG
 
 - UNRELEASED
-     * #482 Add ConfigSearchStrategy to allow avoiding getCurrentDirectory when loading config (by Jan Hrček)
+     * #482 Add `ConfigSearchStrategy` to allow avoiding `getCurrentDirectory` when loading config (by Jan Hrček)
+       this is breaking API change that can be fixed like this:
+        ```diff
+         -format Nothing maybeFile contents
+         +format SearchFromCurrentDirectory maybeFile contents
+
+         -format (Just cfgFile) maybeFile content
+         +format (UseConfig cfgFile) maybeFile content
+        ```
 
 - 0.14.6.0 (2024-01-19)
      * #471 Support GHC 9.8 (by Michael Peyton Jones)