Skip to content

Commit 940c52c

Browse files
kevin-leekevin-lee
authored
Merge pull request #533 from kevin-lee/prepare-to-release
logger-f v2.0.0
2 parents c5f6abd + 312e3d2 commit 940c52c

File tree

2 files changed

+321
-1
lines changed

2 files changed

+321
-1
lines changed

‎changelogs/2.0.0.md‎

Lines changed: 321 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,321 @@
1+
## [2.0.0](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1) - 2024-12-02
2+
3+
* Temporarily disable `Scala.js` support (#531)
4+
* LoggerF v2 to support Effectie v2 (#259)
5+
6+
It also includes all the changes in the following releases.
7+
8+
## [2.0.0-beta1](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+created%3A%3C%3D2022-03-07) - 2022-05-03
9+
10+
## Done
11+
* Upgrade `Effectie` to `v2` (#263)
12+
* Drop `Scalaz Effect` support (#265)
13+
* Move `Log` typeclass to `core` and keep the instances in the sub-projects (#266)
14+
* Add `F[A].log()` syntax and more to `logger-f-cats` (#272)
15+
* Stop releasing `logger-f-cats-effect`, `logger-f-cats-effect3` and `logger-f-monix` (#275)
16+
* Redesign `LeveledMessage` (#278)
17+
* Add `ToLog[A]` type-class to support logging type `A` (#280)
18+
* `ToLog` type-class instance using `cats.Show` (#283)
19+
* Redesign `loggerf.core.syntax` and `loggerf.cats.syntax` (#285)
20+
* Support `Scala.js` (#291)
21+
---
22+
23+
## [2.0.0-beta2](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+created%3A2022-03-07..2022-09-24) - 2022-09-25
24+
25+
## Done
26+
* Add `ignoreA(A)` syntax (#307)
27+
```scala
28+
val fa: F[Option[A]] = ...
29+
log(fa)(info("Not found"), ignoreA)
30+
fa.log(info("Not found"), ignoreA)
31+
// If None, log "Not found"
32+
// If Some(value), ignore logging
33+
```
34+
```scala
35+
val fab: F[Either[A, B]] = ...
36+
log(fab)(ignoreA, b => info(s"It's Right($b)"))
37+
fab.log(ignoreA, b => info(s"It's Right($b)"))
38+
// If Left, ignore logging
39+
// If Right, log
40+
```
41+
```scala
42+
val fab: F[Either[A, B]] = ...
43+
log(fab)(a => info(s"It's Left($a)"), ignoreA)
44+
fab.log(a => info(s"It's Left($a)"), ignoreA)
45+
// If Left, log
46+
// If Right, ignore logging
47+
```
48+
* Upgrade `effectie` to `2.0.0-beta2` (#311)
49+
* Remove `logPure()` (#314)
50+
* `logPure()` is unnecessary as `log()` should use `pureOf` internally instead of `effectOf`.
51+
* Upgrade log libraries (#316)
52+
* `SLF4J`: `1.7.30` => `1.7.36`
53+
* `Logback`: `1.2.10` => `1.2.11`
54+
* `Log4j 2`: `2.17.0` => `2.19.0`
55+
* Remove `effectie-syntax` from the `logger-f-core` project (#318)
56+
* Move `loggerf.cats.instances.logF` to `loggerf.instances.cats` (#321)
57+
* Change `loggerf.cats.syntax` to `loggerf.syntax` (#322)
58+
* `loggerf.cats.show` => `loggerf.instances.show` (#326)
59+
* `loggerf.future.instances.logFuture` => `loggerf.instances.future.logFuture` (#329)
60+
61+
---
62+
63+
## [2.0.0-beta3](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2022-09-25..2022-11-17) - 2022-11-17
64+
65+
## New Features
66+
* Add `ToLog` instance for `String` (`ToLog[String]`) (#334)
67+
* Add `ToLog.by[A](A => String): ToLog[A]` (#335)
68+
```scala
69+
final case class Foo(n: Int)
70+
71+
val fooToLog = ToLog.by[Foo](n => s"n: ${n.toString}")
72+
// ToLog[Foo]
73+
fooToLog.toLogMessage(Foo(123))
74+
// n: 123
75+
```
76+
* Add `ToLog.fromToString[A]` to construct an instance of `ToLog[A]` (#339)
77+
```scala
78+
final case class Foo(n: Int)
79+
80+
implicit val fooToLog: ToLog[Foo] = ToLog.fromToString[Foo]
81+
82+
ToLog[Foo].toLogMessage(Foo(999))
83+
// Foo(999)
84+
```
85+
* Add `prefix(String): Prefix` and other methods to use it (#337)
86+
* Add `debugAWith`, `infoAWith`, `warnAWith`, `errorAWith` taking `Prefix` (#342)
87+
* Scala 2
88+
```scala
89+
def debugAWith[A: ToLog](prefix: Prefix): A => LogMessage with NotIgnorable
90+
def infoAWith[A: ToLog](prefix: Prefix): A => LogMessage with NotIgnorable
91+
def warnAWith[A: ToLog](prefix: Prefix): A => LogMessage with NotIgnorable
92+
def errorAWith[A: ToLog](prefix: Prefix): A => LogMessage with NotIgnorable
93+
```
94+
* Scala 3
95+
```scala
96+
def debugAWith[A: ToLog](prefix: Prefix): A => LeveledMessage
97+
def infoAWith[A: ToLog](prefix: Prefix): A => LeveledMessage
98+
def warnAWith[A: ToLog](prefix: Prefix): A => LeveledMessage
99+
def errorAWith[A: ToLog](prefix: Prefix): A => LeveledMessage
100+
```
101+
102+
## Internal Housekeeping
103+
* Bump Effectie to `2.0.0-beta3` (#351)
104+
105+
---
106+
107+
## [2.0.0-beta4](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2022-11-18..2022-12-25) - 2022-12-25 🎄
108+
109+
## New Features
110+
* Add `log_` returning `F[Unit]` (#355)
111+
```scala
112+
Log[F].log_(pureOf("blah"))(info) // log info blah then returns F[Unit]
113+
log_(pureOf("blah"))(info) // log info blah then returns F[Unit]
114+
```
115+
* Add `logS(String)(String => LogMessage with NotIgnorable): F[String]` (#358)
116+
```scala
117+
logS(String)(String => LogMessage with NotIgnorable): F[String]
118+
String.logS(String => LogMessage with NotIgnorable): F[String]
119+
```
120+
* Add `logS_(String)(String => LogMessage with NotIgnorable): F[Unit]` (#359)
121+
```scala
122+
logS_(String)(String => LogMessage with NotIgnorable): F[Unit]
123+
String.logS_(String => LogMessage with NotIgnorable): F[Unit]
124+
```
125+
126+
127+
## Internal Housekeeping
128+
* Bump Effectie to `2.0.0-beta4` (#362)
129+
* Bump logging libraries (#363)
130+
* Slf4J `1.7.36` => `2.0.6`
131+
* Logback `1.2.11` => `1.4.5`
132+
133+
---
134+
135+
## [2.0.0-beta5](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2022-12-26..2023-01-14) - 2023-01-14
136+
137+
## Bug Fix
138+
* Fix `non-private` `val` in `GetLogger` which is for extension methods for `CanLog` (#368)
139+
140+
141+
## Internal Housekeeping
142+
* Upgrade `effectie` to `2.0.0-beta5` and `cats` to `2.7.0` (#372)
143+
* Enable Scalafmt and Scalafix checks (#370)
144+
145+
---
146+
147+
## [2.0.0-beta6](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-01-15..2023-01-21) - 2023-01-22
148+
149+
## Bug Fix
150+
* Fix: Dynamic log level change is not applied for Slf4J logger (#376)
151+
152+
---
153+
154+
## [2.0.0-beta7](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-01-22..2023-02-06) - 2023-02-07
155+
156+
## New Feature
157+
* Add `logger-f-test-kit` with `CanLog` instance for testing (#388)
158+
159+
## Improvement
160+
* Make `logS`, `logS_` and `prefix` lazy with call-by-name and thunk (#379)
161+
162+
---
163+
164+
## [2.0.0-beta8](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-02-07..2023-02-07) - 2023-02-07
165+
166+
## Bug Fix
167+
* `debug(Prefix)`, `info(Prefix)`, `warn(Prefix)` and `error(Prefix)` do not work with `logS` and `logS_` (#395)
168+
169+
---
170+
171+
## [2.0.0-beta9](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-02-08..2023-02-12) - 2023-02-12
172+
173+
## Internal Housekeeping
174+
* Upgrade `effectie` to `2.0.0-beta6` (#400)
175+
176+
---
177+
178+
## [2.0.0-beta10](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-02-13..2023-02-26) - 2023-02-26
179+
180+
## Update
181+
* Add missing `implicit` instance messages (#410)
182+
183+
## Internal Housekeeping
184+
* Upgrade `effectie` to `2.0.0-beta7` (#413)
185+
* Bump and clean up libraries (#415)
186+
* Bump: `hedgehog-extra` to `0.3.0`
187+
* Remove `extras-cats` from `logger-f-cats` and `logger-f-test-kit` as it's not used by them
188+
189+
---
190+
191+
## [2.0.0-beta11](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-02-27..2023-03-08) - 2023-03-08
192+
193+
## Internal Housekeeping
194+
* Upgrade `effectie` to `2.0.0-beta8` (#420)
195+
196+
---
197+
198+
## [2.0.0-beta12](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-03-09..2023-03-18) - 2023-03-18
199+
200+
## Internal Housekeeping
201+
* Upgrade `effectie` to `2.0.0-beta9` (#428)
202+
203+
---
204+
205+
## [2.0.0-beta13](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-03-19..2023-07-07) - 2023-07-07
206+
207+
## New Feature
208+
* Add `MdcAdapter` for Monix to properly share context through `MDC` with `Task` and `Local` from Monix (#438)
209+
210+
---
211+
212+
## [2.0.0-beta14](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-07-08..2023-07-15) - 2023-07-15
213+
214+
## Change
215+
* [`logger-f-logback-mdc-monix3`] Renamed: `MonixMdcAdapter` to `Monix3MdcAdapter` (#442)
216+
217+
## Bug Fix
218+
* Fixed: `Monix3MdcAdapter.initialize()` is broken for logback `1.4.8` (#444)
219+
220+
---
221+
222+
## [2.0.0-beta15](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-07-15..2023-07-15+created%3A2023-07-15) - 2023-07-15
223+
224+
## Internal Housekeeping
225+
226+
* Upgrade `effectie` to `2.0.0-beta10` (#448)
227+
228+
---
229+
230+
## [2.0.0-beta16](https://github.com/Kevin-Lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-07-16..2023-07-17) - 2023-07-17
231+
232+
## New Feature
233+
234+
* Add `initialize` method taking `Monix3MdcAdapter` in the companion object of `Monix3MdcAdapter` (#452)
235+
236+
---
237+
238+
## [2.0.0-beta17](https://github.com/kevin-lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-07-18..2023-07-23) - 2023-07-23
239+
240+
## Internal Housekeeping
241+
242+
* Upgrade `effectie` to `2.0.0-beta11` (#457)
243+
244+
---
245+
246+
## [2.0.0-beta18](https://github.com/kevin-lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+created%3A2023-09-04+closed%3A2023-07-24..2023-09-05) - 2023-09-05
247+
248+
## New Feature
249+
250+
* Add `Log` instance for `Try` - `Log[Try]` (#469)
251+
252+
---
253+
254+
## [2.0.0-beta19](https://github.com/kevin-lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+created%3A2023-09-05+closed%3A2023-09-05..2023-09-05) - 2023-09-06
255+
256+
## Changed
257+
258+
* Remove unnecessary `FxCtor` from `loggerf.instances.future.logFuture` (#473)
259+
260+
Since `loggerf.instances.future.LogFuture` can just have `effectie.instances.future.fxCtor.fxCtorFuture`, it's not required to have `EF: FxCtor[Future]` as a parameter of `loggerf.instances.future.logFuture`.
261+
262+
---
263+
264+
## [2.0.0-beta20](https://github.com/kevin-lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-09-06..2023-09-09) - 2023-09-09
265+
266+
## Internal Housekeeping
267+
268+
* Upgrade effectie to `2.0.0-beta12` (#478)
269+
* Upgrade logback to `1.4.8` (#480)
270+
271+
---
272+
273+
## [2.0.0-beta21](https://github.com/kevin-lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-09-10..2023-10-01) - 2023-10-01
274+
275+
## Internal Housekeeping
276+
277+
* Upgrade effectie to `2.0.0-beta13` (#488)
278+
279+
---
280+
281+
## [2.0.0-beta22](https://github.com/kevin-lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-10-02..2023-11-07) - 2023-11-08
282+
283+
## Change
284+
285+
* Change the `LogMessage` parameter in the `log(F[A])` method from `NotIgnorable` to `MaybeIgnorable` (#498)
286+
This could be required and useful for case like
287+
288+
```scala
289+
final case class Something(id: Int, name: String)
290+
291+
val fa: F[Something] = ...
292+
Log[F].log(fa) {
293+
case Something(0, _) => ignore
294+
case Something(n, name) => info(s"Something: id=$n, name=$name")
295+
}
296+
```
297+
298+
## Improvement
299+
300+
* Remove unnecessary re-evaluation of `String` in `logS` (#500)
301+
`msg()` and `message` (call-by-name) below in line 61 (Scala 2) and line 62 (Scala 3) were replaced with a single lazy evaluation.
302+
303+
https://github.com/kevin-lee/logger-f/blob/47a0ad183bf4b3b847661143e31a85c302d02146/modules/logger-f-core/shared/src/main/scala-2/loggerf/core/Log.scala#L56-L62
304+
305+
https://github.com/kevin-lee/logger-f/blob/47a0ad183bf4b3b847661143e31a85c302d02146/modules/logger-f-core/shared/src/main/scala-3/loggerf/core/Log.scala#L59-L63
306+
307+
---
308+
309+
## [2.0.0-beta23](https://github.com/kevin-lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-11-08..2023-12-04) - 2023-12-05
310+
311+
## Internal Housekeeping
312+
313+
* [`logger-f-logback-mdc-monix3`] Bump `logback-scala-interop` to `0.2.0` (#508)
314+
315+
---
316+
317+
## [2.0.0-beta24](https://github.com/kevin-lee/logger-f/issues?q=is%3Aissue+is%3Aclosed+milestone%3Av2-m1+closed%3A2023-12-05..2024-01-13) - 2024-01-14
318+
319+
## Internal Housekeeping
320+
* Upgrade `effectie` to `2.0.0-beta14` (#514)
321+
* [`logger-f-logback-mdc-monix3`] Bump `logback` to `1.4.9` and `logback-scala-interop` to `0.3.0` (#516)

‎version.sbt‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)