From 85507a1e06dc2028051294ffbd85c941e863c121 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Mon, 25 Sep 2023 01:03:03 -0700 Subject: [PATCH] Minor cleanup --- .github/workflows/gradle.yml | 4 ++-- README.md | 9 +++++++-- build.gradle.kts | 15 ++++++++++----- config/dokka/packages.md | 5 +++++ pom.xml | 14 +++++++------- 5 files changed, 31 insertions(+), 16 deletions(-) create mode 100644 config/dokka/packages.md diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml index a1e879d..42bc1da 100644 --- a/.github/workflows/gradle.yml +++ b/.github/workflows/gradle.yml @@ -8,11 +8,11 @@ jobs: env: GRADLE_OPTS: "-Dorg.gradle.jvmargs=-XX:MaxMetaspaceSize=512m" - SONAR_JDK: "11" + SONAR_JDK: "17" strategy: matrix: - java-version: [ 11, 18 ] + java-version: [ 11, 17, 20 ] steps: - uses: actions/checkout@v3 diff --git a/README.md b/README.md index f31ede5..0e7a2fa 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,12 @@ returns: All of the [is.gd API](https://is.gd/developers.php) parameters are supported: ```kotlin -Isgd.shorten(url = url, shorturl="foobar", callback = "test", logstats = true, format = Format.JSON) +Isgd.shorten( + url = url, + shorturl="foobar", + callback = "test", + logstats = true, + format = Format.JSON) ``` returns: @@ -90,7 +95,7 @@ var config = new Config.Builder() .format(Format.XML) .build(); -Isgd.lookup(config) +Isgd.lookup(config); ``` ### Errors diff --git a/build.gradle.kts b/build.gradle.kts index 1ad8573..59fe0e8 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,6 +1,6 @@ -import org.jetbrains.kotlin.gradle.tasks.KotlinCompile import org.gradle.api.tasks.testing.logging.TestExceptionFormat import org.gradle.api.tasks.testing.logging.TestLogEvent +import org.jetbrains.kotlin.gradle.tasks.KotlinCompile plugins { id("com.github.ben-manes.versions") version "0.48.0" @@ -107,6 +107,15 @@ tasks { } } + dokkaJavadoc { + dokkaSourceSets { + configureEach { + includes.from("config/dokka/packages.md") + } + } + mustRunAfter("kaptKotlin") + } + val copyToDeploy by registering(Copy::class) { from(configurations.runtimeClasspath) { exclude("annotations-*.jar") @@ -144,10 +153,6 @@ tasks { group = PublishingPlugin.PUBLISH_TASK_GROUP dependsOn("deploy", gitTag, publishToMavenLocal) } - - "sonar" { - dependsOn(koverReport) - } } publishing { diff --git a/config/dokka/packages.md b/config/dokka/packages.md new file mode 100644 index 0000000..69146fb --- /dev/null +++ b/config/dokka/packages.md @@ -0,0 +1,5 @@ +# Module isgd-shorten + +Isgd Shortener for Kotlin, Java & Android + +A simple implementation of the `is.gd` URL shortening and lookup APIs. diff --git a/pom.xml b/pom.xml index a3b26de..2e58948 100644 --- a/pom.xml +++ b/pom.xml @@ -27,8 +27,8 @@ - scm:git://github.com/ethauvin/isgd-shorten.git - scm:git@github.com:ethauvin/isgd-shorten.git + scm:git:https://github.com/ethauvin/isgd-shorten.git + scm:git:git@github.com:ethauvin/isgd-shorten.git https://github.com/ethauvin/isgd-shorten @@ -40,7 +40,7 @@ org.jetbrains.kotlin kotlin-bom - 1.8.0 + 1.9.10 pom import @@ -50,13 +50,13 @@ org.jetbrains.kotlin kotlin-stdlib-jdk8 - 1.8.0 + 1.9.10 compile - net.thauvin.erik - urlencoder - 1.3.0 + net.thauvin.erik.urlencoder + urlencoder-lib-jvm + 1.4.0 runtime