Skip to content

Commit

Permalink
Add change log for plugins v0.9.0, and fix misuses of the word "depen…
Browse files Browse the repository at this point in the history
…dent" BTW
  • Loading branch information
ShreckYe committed Dec 4, 2024
1 parent 72dc9cf commit 9214899
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 8 deletions.
2 changes: 1 addition & 1 deletion COMMON_GRADLE_DEPENDENCIES_CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 6 additions & 0 deletions PLUGINS_CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:

Expand Down
2 changes: 1 addition & 1 deletion architecture-common-gradle-plugins/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
Expand Down
2 changes: 1 addition & 1 deletion buildSrc/src/main/kotlin/VersionsAndDependencies.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ plugins {
}

dependencies {
implementation("com.huanshankeji:common-gradle-dependencies:$pluginProjectSourceDependentStableCommonGradleDependenciesVersion")
implementation("com.huanshankeji:common-gradle-dependencies:$pluginProjectSourceDependencyStableCommonGradleDependenciesVersion")
}

tasks.named<KotlinCompilationTask<*>>("compileKotlin").configure {
Expand Down
Original file line number Diff line number Diff line change
@@ -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<String>) {
// 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<String>) {

/**
* @see SourceSetType
Expand Down

0 comments on commit 9214899

Please sign in to comment.