Update CHANGELOG (#64)

primait · Jul 29, 2022 · b58e01b · b58e01b
1 parent aded4db
commit b58e01b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Next]
 
+## [2.1.1] - 2022-07-29
+
+### Changed
+
+- **Deprecation**: a warning is emitted if global `log_options` config is set. This option was introduced to save some boilerplate when multiple bridges are used in the same app, but it's a footgun for umbrella apps and a bad design pattern for libraries
+
 ## [2.1.0] - 2022-07-07
 
 ### Added

diff --git a/README.md b/README.md
@@ -100,12 +100,14 @@ end
 BridgeWithCustomRetry.call("myquery", %{}, retry_options: [policy: retry_policy, max_retries: 2])
 ```
 
-### Global configuration
+### (Deprecated) Global configuration
 
 The following configuration parameters can be set globally for all bridges in the app, by setting them inside your `config.exs`:
 
 - `config :bridge_ex, log_options: [log_query_on_error: true, log_response_on_error: false]` to customize logging in your bridges
 
+Please note that this config has been **deprecated** since it's a footgun for umbrella apps and bad library design in general.
+
 ### Authenticating calls via Auth0
 
 `bridge_ex` supports authentication of machine-to-machine calls via Auth0, through the [prima_auth0_ex](https://github.com/primait/auth0_ex) library.