diff --git a/CHANGELOG.md b/CHANGELOG.md index 66a3dc9..59a3a1b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ - Add printing of the Panache query at DEBUG log level - **Note:** output does not follow a specific format like SQL, JPQL, or HQL, and should only be used in debugging Use Hibernate's SQL logging functionality to see what is actually being queried +- Add basic documentation for exposed API ## 0.0.3 - Remove `whereGroup`, `andGroup`, and `orGroup` functions in favor of expression chaining diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ce4dbdc..f73a0f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Release Checklist -- Make sure all tests are passing so we can be fairly sure there are no regressions - Update `version` in gradle.properties to match this release's tag - Upgrade all unpinned dependencies in both the library and tests project's gradle.properties +- Make sure all tests are passing so we can be fairly sure there are no regressions - Make sure the versions in the README's Requirements section match the actual dependencies - Add a new section to the CHANGELOG describing what has changed - Update the versions in the README's Getting Started section and the Maven Central badge diff --git a/README.md b/README.md index ea5c10b..e2454c7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ [![License](https://img.shields.io/badge/license-Apache_2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt) -[![Maven Central](https://img.shields.io/badge/maven_central-0.0.3-brightgreen.svg)](https://search.maven.org/artifact/ch.icken/panache-kotlin-dsl/0.0.3/jar) +[![Maven Central](https://img.shields.io/badge/maven_central-0.0.4-brightgreen.svg)](https://search.maven.org/artifact/ch.icken/panache-kotlin-dsl/0.0.4/jar) [![Test](https://github.com/Thijsiez/panache-kotlin-dsl/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/Thijsiez/panache-kotlin-dsl/actions/workflows/test.yaml) ![Quality Gate Status](https://sonarqube.icken.ch/api/project_badges/measure?project=Thijsiez_panache-kotlin-dsl_760170ef-68c7-43b0-880d-cf1034afe3c6&metric=alert_status&token=sqb_cfafb36de6f18194da2e383324ee281b0de5b953) ![Reliability Rating](https://sonarqube.icken.ch/api/project_badges/measure?project=Thijsiez_panache-kotlin-dsl_760170ef-68c7-43b0-880d-cf1034afe3c6&metric=reliability_rating&token=sqb_cfafb36de6f18194da2e383324ee281b0de5b953) @@ -24,14 +24,14 @@ A dynamic, type-safe way to write your queries Add the KSP Gradle plugin to your build file ```kotlin plugins { - id("com.google.devtools.ksp") version "2.0.21-1.0.26" + id("com.google.devtools.ksp") version "2.0.21-1.0.28" } ``` Add this library to your build file and register it with KSP ```kotlin dependencies { - implementation("ch.icken:panache-kotlin-dsl:0.0.3") - ksp("ch.icken:panache-kotlin-dsl:0.0.3") + implementation("ch.icken:panache-kotlin-dsl:0.0.4") + ksp("ch.icken:panache-kotlin-dsl:0.0.4") } ``` Optionally configure the behavior @@ -76,7 +76,7 @@ project.afterEvaluate { - Kotlin version `1.9.23` or newer - KSP version `1.9.23-1.0.20` or newer - Your KSP version needs to match your Kotlin version. This is a strict requirement! - For example, when your Kotlin version is `2.0.21`, your KSP version needs to be built for and start with the same version, such as `2.0.21-1.0.25` + For example, when your Kotlin version is `2.0.21`, your KSP version needs to be built for and start with the same version, such as `2.0.21-1.0.28` ## Features ### Queries diff --git a/gradle.properties b/gradle.properties index 832ba10..ac7b131 100644 --- a/gradle.properties +++ b/gradle.properties @@ -17,7 +17,7 @@ #region POM groupId=ch.icken artifactId=panache-kotlin-dsl -version=0.0.3 +version=0.0.4 POM_NAME=Panache Kotlin DSL POM_DESCRIPTION=A dynamic, type-safe way to write your queries diff --git a/tests/gradle.properties b/tests/gradle.properties index 8741b77..3935f4c 100644 --- a/tests/gradle.properties +++ b/tests/gradle.properties @@ -17,7 +17,7 @@ #region Dependencies #https://github.com/quarkusio/quarkus # Can be upgraded freely and probably should be -quarkusVersion=3.16.2 +quarkusVersion=3.17.3 #https://github.com/JetBrains/kotlin # Needs to match Quarkus Kotlin version for compatibility @@ -25,7 +25,7 @@ kotlinVersion=2.0.21 #https://github.com/google/ksp # Latest version matching the above Kotlin version -kspVersion=2.0.21-1.0.27 +kspVersion=2.0.21-1.0.28 #endregion #region Plugins