From 921489904e02f29e4871fc4f4a735ad4b112ed30 Mon Sep 17 00:00:00 2001 From: Yongshun Shreck Ye Date: Thu, 5 Dec 2024 00:48:21 +0800 Subject: [PATCH] Add change log for plugins v0.9.0, and fix misuses of the word "dependent" BTW --- COMMON_GRADLE_DEPENDENCIES_CHANGELOG.md | 2 +- PLUGINS_CHANGELOG.md | 6 ++++++ README.md | 4 ++-- architecture-common-gradle-plugins/build.gradle.kts | 2 +- buildSrc/src/main/kotlin/VersionsAndDependencies.kt | 2 +- .../kotlin/aligned-version-plugin-conventions.gradle.kts | 2 +- .../src/main/kotlin/com/huanshankeji/SourceSetConfig.kt | 4 ++-- 7 files changed, 14 insertions(+), 8 deletions(-) diff --git a/COMMON_GRADLE_DEPENDENCIES_CHANGELOG.md b/COMMON_GRADLE_DEPENDENCIES_CHANGELOG.md index 520da98..7a28bad 100644 --- a/COMMON_GRADLE_DEPENDENCIES_CHANGELOG.md +++ b/COMMON_GRADLE_DEPENDENCIES_CHANGELOG.md @@ -1,6 +1,6 @@ # "common-gradle-dependencies" change log -## v0.9.0-20241203 / 2024-12-5 +## v0.9.0-20241203 / 2024-12-05 * bump the dependency versions in `CommonVersions` to the latest as of Dec 3, 2024 (including pre-release versions except for Vert.x 5) * add a version for kotlinx-io diff --git a/PLUGINS_CHANGELOG.md b/PLUGINS_CHANGELOG.md index 442a340..82e5fc9 100644 --- a/PLUGINS_CHANGELOG.md +++ b/PLUGINS_CHANGELOG.md @@ -1,5 +1,11 @@ # "Gradle plugins" change log +## v0.9.0 / 2024-12-05 + +There are no functional changes in this release. + +* bump the dependency common-gradle-dependencies to v0.9.0-20241203 + ## v0.8.0 / 2024-12-03 * bump Kotlin to 2.1.0, Gradle to v8.1.11, kotlinx-benchmark to v0.4.13, and Compose Multiplatform to v1.7.1 diff --git a/README.md b/README.md index d3b535e..7f445da 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,11 @@ There are currently no docs or tutorials on how to use the plugins. [Check out t ## Gradle version and Kotlin version -See [gradle/wrapper/gradle-wrapper.properties](gradle/wrapper/gradle-wrapper.properties) for the currently dependent Gradle version and [buildSrc/build.gradle.kts](buildSrc/build.gradle.kts) for the currently dependent Kotlin version. These versions are tested against and used by us. There might be compatibility issues when you use other versions of Gradle or Kotlin, especially versions with different [MAJOR](https://semver.org/) versions. +See [gradle/wrapper/gradle-wrapper.properties](gradle/wrapper/gradle-wrapper.properties) for the current dependency Gradle version and [buildSrc/build.gradle.kts](buildSrc/build.gradle.kts) for the current dependency Kotlin version. These versions are tested against and used by us. There might be compatibility issues when you use other versions of Gradle or Kotlin, especially versions with different [MAJOR](https://semver.org/) versions. ### About the version of the Kotlin Gradle plugins -The projects and plugins depend on a certain version of the Kotlin Gradle plugins. Sometimes it's needed to specify your own version of the Kotlin Gradle plugins when using the plugins in your project. For example, a version of [Compose Multiplatform](https://www.jetbrains.com/lp/compose-mpp/) currently supports only a certain version of the Kotlin Gradle plugins. Especially, if your desired Kotlin version is lower than this project's dependent Kotlin version, you need to exclude the transitive Kotlin dependencies. +The projects and plugins depend on a certain version of the Kotlin Gradle plugins. Sometimes it's needed to specify your own version of the Kotlin Gradle plugins when using the plugins in your project. For example, a version of [Compose Multiplatform](https://www.jetbrains.com/lp/compose-mpp/) currently supports only a certain version of the Kotlin Gradle plugins. Especially, if your desired Kotlin version is lower than this project's dependency Kotlin version, you need to exclude the transitive Kotlin dependencies. For example, with Compose 1.3.1 in `buildSrc/build.gradle.kts`: diff --git a/architecture-common-gradle-plugins/build.gradle.kts b/architecture-common-gradle-plugins/build.gradle.kts index daa46be..673d309 100644 --- a/architecture-common-gradle-plugins/build.gradle.kts +++ b/architecture-common-gradle-plugins/build.gradle.kts @@ -5,7 +5,7 @@ plugins { dependencies { implementation(project(":kotlin-common-gradle-plugins")) implementation("org.jetbrains.kotlin:compose-compiler-gradle-plugin:${DependencyVersions.kotlin}") - // use the version in `buildSrc` so there is no need to frequently update the dependent bootstrapping `common-gradle-dependencies` version in "buildSrc" + // use the version in `buildSrc` so there is no need to frequently update the dependency bootstrapping `common-gradle-dependencies` version in "buildSrc" implementation("org.jetbrains.compose:compose-gradle-plugin:${DependencyVersions.composeMultiplatform}") //api(project(":common-gradle-dependencies")) diff --git a/buildSrc/src/main/kotlin/VersionsAndDependencies.kt b/buildSrc/src/main/kotlin/VersionsAndDependencies.kt index 14fa89b..08d6592 100644 --- a/buildSrc/src/main/kotlin/VersionsAndDependencies.kt +++ b/buildSrc/src/main/kotlin/VersionsAndDependencies.kt @@ -20,6 +20,6 @@ val alignedPluginVersion = "0.9.0-SNAPSHOT" val commonGradleDependenciesVersion = "0.9.0-20241203-SNAPSHOT" // This is the source dependency version. There is another build source dependency in "buildSrc/build.gradle.kts". -val pluginProjectSourceDependentStableCommonGradleDependenciesVersion = "0.9.0-20241203".apply { +val pluginProjectSourceDependencyStableCommonGradleDependenciesVersion = "0.9.0-20241203".apply { require(!endsWith("SNAPSHOT")) // comment this out when debugging and testing snapshots } diff --git a/buildSrc/src/main/kotlin/aligned-version-plugin-conventions.gradle.kts b/buildSrc/src/main/kotlin/aligned-version-plugin-conventions.gradle.kts index 174453d..95ec58f 100644 --- a/buildSrc/src/main/kotlin/aligned-version-plugin-conventions.gradle.kts +++ b/buildSrc/src/main/kotlin/aligned-version-plugin-conventions.gradle.kts @@ -7,7 +7,7 @@ plugins { } dependencies { - implementation("com.huanshankeji:common-gradle-dependencies:$pluginProjectSourceDependentStableCommonGradleDependenciesVersion") + implementation("com.huanshankeji:common-gradle-dependencies:$pluginProjectSourceDependencyStableCommonGradleDependenciesVersion") } tasks.named>("compileKotlin").configure { diff --git a/kotlin-common-gradle-plugins/src/main/kotlin/com/huanshankeji/SourceSetConfig.kt b/kotlin-common-gradle-plugins/src/main/kotlin/com/huanshankeji/SourceSetConfig.kt index 1c29bf4..4938306 100644 --- a/kotlin-common-gradle-plugins/src/main/kotlin/com/huanshankeji/SourceSetConfig.kt +++ b/kotlin-common-gradle-plugins/src/main/kotlin/com/huanshankeji/SourceSetConfig.kt @@ -1,8 +1,8 @@ package com.huanshankeji // TODO use or remove -// TODO How should dependents be added, the "implementation" way or "api" way? Does this make this class too complicated and unnecessary as one can just call the Gradle functions directly? -class SourceSetConfig(val type: Type, val name: String, val dependents: List) { +// TODO How should dependencies be added, the "implementation" way or "api" way? Does this make this class too complicated and unnecessary as one can just call the Gradle functions directly? +class SourceSetConfig(val type: Type, val name: String, val dependencies: List) { /** * @see SourceSetType