3
3
Structured logging library for Kotlin, that aims to provide a developer-friendly API with minimal
4
4
runtime overhead. Currently only supports the JVM platform, wrapping SLF4J.
5
5
6
- - Docs: [ devlog-kotlin.hermannm.dev] ( https://devlog-kotlin.hermannm.dev )
7
- - Published on:
8
- - klibs.io:
9
- [ klibs.io/project/hermannm/devlog-kotlin] ( https://klibs.io/project/hermannm/devlog-kotlin )
10
- - Maven Central:
11
- [ central.sonatype.com/artifact/dev.hermannm/devlog-kotlin] ( https://central.sonatype.com/artifact/dev.hermannm/devlog-kotlin )
6
+ ** Docs:** [ devlog-kotlin.hermannm.dev] ( https://devlog-kotlin.hermannm.dev )
7
+
8
+ ** Published on:**
9
+
10
+ - klibs.io:
11
+ [ klibs.io/project/hermannm/devlog-kotlin] ( https://klibs.io/project/hermannm/devlog-kotlin )
12
+ - Maven Central:
13
+ [ central.sonatype.com/artifact/dev.hermannm/devlog-kotlin] ( https://central.sonatype.com/artifact/dev.hermannm/devlog-kotlin )
12
14
13
15
** Contents:**
14
16
@@ -20,7 +22,7 @@ runtime overhead. Currently only supports the JVM platform, wrapping SLF4J.
20
22
- [ Automatic logger names] ( #automatic-logger-names )
21
23
- [ Project Structure] ( #project-structure )
22
24
- [ Why another logging library?] ( #why-another-logging-library )
23
- - [ Developer 's guide] ( #developers -guide )
25
+ - [ Maintainer 's guide] ( #maintainers -guide )
24
26
- [ Credits] ( #credits )
25
27
26
28
## Usage
@@ -372,9 +374,9 @@ improve with this library:
372
374
provide ` JsonContextFieldWriter ` for interoperability with ` MDC ` when using Logback +
373
375
` logstash-logback-encoder ` .
374
376
375
- ## Developer 's guide
377
+ ## Maintainer 's guide
376
378
377
- Updating dependencies:
379
+ ### Updating dependencies
378
380
379
381
- Run:
380
382
```
@@ -383,18 +385,18 @@ Updating dependencies:
383
385
- Also check for new versions of [ ` ktfmt ` ] ( https://github.com/facebook/ktfmt ) , and update the
384
386
` ktfmt ` entry under ` spotless ` in ` build.gradle.kts `
385
387
386
- Checking binary compatibility:
388
+ ### Checking binary compatibility
387
389
388
390
- We use the Kotlin
389
391
[ Binary Compatibility Validator] ( https://github.com/Kotlin/binary-compatibility-validator ) to
390
392
avoid accidental breaking changes
391
- - This plugin generates an ` api/devlog-kotlin.api ` file that contains all the public APIs of the
392
- library. When making changes to the library, any changes to the library's public API will be
393
- checked against this file (in the ` apiCheck ` Gradle task), to detect possible breaking changes
394
- - When _ adding_ new APIs (which should not be a breaking change), you must update this ` .api ` file
395
- by running the ` apiDump ` Gradle task
393
+ - This plugin generates an ` api/devlog-kotlin.api ` file that contains all the public APIs of the
394
+ library. When making changes to the library, any changes to the library's public API will be
395
+ checked against this file (in the ` apiCheck ` Gradle task), to detect possible breaking changes
396
+ - When _ adding_ new APIs (which should not be a breaking change), you must update this ` .api ` file
397
+ by running the ` apiDump ` Gradle task
396
398
397
- Publishing a new release:
399
+ ### Publishing a new release
398
400
399
401
- Run tests:
400
402
```
0 commit comments