Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: oshai/kotlin-logging
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 2.1.23
Choose a base ref
...
head repository: oshai/kotlin-logging
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 3.0.0
Choose a head ref
  • 8 commits
  • 10 files changed
  • 5 contributors

Commits on Jun 1, 2022

  1. fix kdoc of mu.KotlinLogging.logger

    aivantsov authored and oshai committed Jun 1, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    4c61b3d View commit details

Commits on Jun 14, 2022

  1. remove 1.x links from readme

    oshai committed Jun 14, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    33a778c View commit details

Commits on Jul 31, 2022

  1. Update FUNDING.yml

    oshai authored Jul 31, 2022
    Copy the full SHA
    7748983 View commit details

Commits on Aug 23, 2022

  1. build(deps): bump log4j to 2.18.0

    yeikel authored and oshai committed Aug 23, 2022
    Copy the full SHA
    30603c7 View commit details

Commits on Aug 26, 2022

  1. Create SECURITY.md (#237)

    * Create SECURITY.md
    
    Co-authored-by: Michael Bailey <1195562+yogurtearl@users.noreply.github.com>
    oshai and yogurtearl authored Aug 26, 2022
    Copy the full SHA
    4b55c15 View commit details

Commits on Sep 2, 2022

  1. Bump gradle wrapper to 7.5.1

    yeikel authored and oshai committed Sep 2, 2022
    Copy the full SHA
    fb91cc1 View commit details

Commits on Sep 18, 2022

  1. build(deps): upgrade slf4j to 2.x

    - Bumps log4j from 2.18.0 to 2.19.0
    - Bumps slf4j from 1.7.32 to 2.0.1
    yeikel authored Sep 18, 2022
    Copy the full SHA
    7335bca View commit details
  2. bump version to 3.0.0

    oshai authored Sep 18, 2022
    Copy the full SHA
    29bc994 View commit details
Showing with 102 additions and 35 deletions.
  1. +2 −2 .github/FUNDING.yml
  2. +1 −21 README.md
  3. +73 −0 SECURITY.md
  4. +8 −2 build.gradle.kts
  5. BIN gradle/wrapper/gradle-wrapper.jar
  6. +1 −1 gradle/wrapper/gradle-wrapper.properties
  7. +6 −0 gradlew
  8. +8 −6 gradlew.bat
  9. +1 −1 src/jsMain/kotlin/mu/KotlinLogging.kt
  10. +2 −2 versions.gradle.kts
4 changes: 2 additions & 2 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# These are supported funding model platforms

github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
github: oshai # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: oshai # Replace with a single Liberapay username
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
22 changes: 1 addition & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -61,36 +61,16 @@ In short, if you just want to log statements to stdout, it's possible to add the
<version>2.1.20</version>
</dependency>
```
or
```xml
<dependency>
<groupId>io.github.microutils</groupId>
<artifactId>kotlin-logging</artifactId>
<version>1.12.5</version>
</dependency>
```
See the full example in [kotlin-logging-example-maven](https://github.com/MicroUtils/kotlin-logging-example-maven).

### Gradle
```Groovy
implementation 'io.github.microutils:kotlin-logging-jvm:2.1.20'
```
or
```Groovy
implementation 'io.github.microutils:kotlin-logging:1.12.5'
```

Alternatively, download the JAR from [github](https://github.com/MicroUtils/kotlin-logging/releases/latest) or [bintray](https://dl.bintray.com/microutils/kotlin-logging/io/github/microutils/kotlin-logging/) or [maven-central](http://repo1.maven.org/maven2/io/github/microutils/kotlin-logging/).

### Version 2.x vs 1.x

**There are currently two supported branches: 1.x and 2.x.**

The main incompatible change is in the artifact names. In version `1.x` the jvm artifact is called `kotlin-logging` while in version `2.x` it's called `kotlin-logging-jvm` to comply with the multiplatform schema. In addition, version 2.x supports only Kotlin >= 1.4.

Therefore, for jvm library owners it is still recommended to use 1.x, as for the rest of the use cases 2.x is recommended.

#### Multiplatform
### Multiplatform

An experimental common & JS & linux-x64 support is available.
More information is available on the [wiki](https://github.com/MicroUtils/kotlin-logging/wiki/Multiplatform-support) and issues [#21](https://github.com/MicroUtils/kotlin-logging/issues/21) [#45](https://github.com/MicroUtils/kotlin-logging/issues/45).
73 changes: 73 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
## Reporting security issues

Please report security issues related to the project to the
following email address:

ohadshai(at)gmail.com




## Verifying contents

All `kotlin-logging` project artifacts published on Maven central are signed. For
each artifact, there is an associated signature file with the .asc
suffix.

### 2.1.14 +

To verify the signature use [this public key](https://keys.openpgp.org/vks/v1/by-fingerprint/47EB6836245D2D40E89DFB4136D4E9618F3ADAB5).
Here is its fingerprint:
```
pub rsa3072 2021-11-27 [SCEA]
47EB6836245D2D40E89DFB4136D4E9618F3ADAB5
sub rsa3072 2021-11-27 [E]
```

A copy of this key is stored on the
[keys.openpgp.org](https://keys.openpgp.org) keyserver. To add it to
your public key ring use the following command:

```
> FINGER_PRINT=47EB6836245D2D40E89DFB4136D4E9618F3ADAB5
> gpg --keyserver hkps://keys.openpgp.org --recv-keys $FINGER_PRINT
```

### 2.0.8-2.0.11

To verify the signature use [this public key](https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x637b8fb6cd0b57ca1e833e897f083a4ab2af5107).
Here is its fingerprint:
```
pub rsa3072 2021-05-30 [SC]
637B8FB6CD0B57CA1E833E897F083A4AB2AF5107
uid Ohad Shai <ohadshai@gmail.com>
sub rsa3072 2021-05-30 [E]
```

A copy of this key is stored on the
[keyserver.ubuntu.com](https://keyserver.ubuntu.com) keyserver. To add it to
your public key ring use the following command:

```
> FINGER_PRINT=637B8FB6CD0B57CA1E833E897F083A4AB2AF5107
> gpg --keyserver hkps://keyserver.ubuntu.com --recv-keys $FINGER_PRINT
```
### 2.0.2-2.0.7

To verify the signature use [this public key](https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xe52567d2589415bd74eb4c2867631bc0568801c3).
Here is its fingerprint:
```
pub rsa4096 2016-08-29 [SC]
E52567D2589415BD74EB4C2867631BC0568801C3
uid Ohad Shai <ohadshai@gmail.com>
sub rsa4096 2016-08-29 [E]
```

A copy of this key is stored on the
[keyserver.ubuntu.com](https://keyserver.ubuntu.com) keyserver. To add it to
your public key ring use the following command:

```
> FINGER_PRINT=E52567D2589415BD74EB4C2867631BC0568801C3
> gpg --keyserver hkps://keyserver.ubuntu.com --recv-keys $FINGER_PRINT
```
10 changes: 8 additions & 2 deletions build.gradle.kts
Original file line number Diff line number Diff line change
@@ -11,10 +11,11 @@ plugins {
id("io.gitlab.arturbosch.detekt") version "1.18.0"
}


apply("versions.gradle.kts")

group = "io.github.microutils"
version = "2.1.24"
version = "3.0.0"

repositories {
mavenCentral()
@@ -91,7 +92,7 @@ kotlin {
implementation("org.mockito:mockito-all:${extra["mockito_version"]}")
implementation("org.apache.logging.log4j:log4j-api:${extra["log4j_version"]}")
implementation("org.apache.logging.log4j:log4j-core:${extra["log4j_version"]}")
implementation("org.apache.logging.log4j:log4j-slf4j-impl:${extra["log4j_version"]}")
implementation("org.apache.logging.log4j:log4j-slf4j2-impl:${extra["log4j_version"]}")
}
}
val jsMain by getting {}
@@ -129,6 +130,11 @@ tasks {
archiveClassifier.set("javadoc")
}

// see https://docs.gradle.org/current/userguide/gradle_wrapper.html#customizing_wrapper
wrapper {
distributionType = Wrapper.DistributionType.ALL
}

withType<Jar> {
metaInf.with(
copySpec {
Binary file modified gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
2 changes: 1 addition & 1 deletion gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-all.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-all.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
6 changes: 6 additions & 0 deletions gradlew
Original file line number Diff line number Diff line change
@@ -205,6 +205,12 @@ set -- \
org.gradle.wrapper.GradleWrapperMain \
"$@"

# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi

# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
14 changes: 8 additions & 6 deletions gradlew.bat
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@
@rem limitations under the License.
@rem

@if "%DEBUG%" == "" @echo off
@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@@ -25,7 +25,7 @@
if "%OS%"=="Windows_NT" setlocal

set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
if "%DIRNAME%"=="" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%

@@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome

set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto execute
if %ERRORLEVEL% equ 0 goto execute

echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -75,13 +75,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar

:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
if %ERRORLEVEL% equ 0 goto mainEnd

:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
set EXIT_CODE=%ERRORLEVEL%
if %EXIT_CODE% equ 0 set EXIT_CODE=1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%

:mainEnd
if "%OS%"=="Windows_NT" endlocal
2 changes: 1 addition & 1 deletion src/jsMain/kotlin/mu/KotlinLogging.kt
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@ import mu.internal.KLoggerJS

public actual object KotlinLogging {
/**
* This method allow defining the logger in a file in the following way:
* This method allows defining the logger in a file in the following way:
* ```
* val logger = KotlinLogging.logger {}
* ```
4 changes: 2 additions & 2 deletions versions.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
extra["slf4j_version"] = "1.7.32"
extra["log4j_version"] = "2.17.1"
extra["slf4j_version"] = "2.0.1"
extra["log4j_version"] = "2.19.0"
extra["mockito_version"] = "1.10.19"
extra["junit_version"] = "5.8.2"