Added two comments about gradle wrapper version configuration

nesk · Jan 24, 2025 · c14cb2a · c14cb2a
1 parent 55454ec
commit c14cb2a
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -6,6 +6,11 @@ repositories {
     mavenCentral()
 }
 
+/*
+ * Configure default gradle wrapper task to validate currently used gradle wrapper version against value set in versions
+ * catalog. When value differs task will automatically update wrapper configuration file with version from catalog.
+ * After this gradle wrapper binary will be updated before next task execution.
+*/
 tasks.named<Wrapper>("wrapper") {
     gradleVersion = libs.versions.gradle.wrapper.get()
 }
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,5 +1,7 @@
 [versions]
 # https://gradle.org/releases/
+# To actually update gradle wrapper binary after updating this value call wrapper task ("gradlew wrapper") and any
+# other task aftewards.
 gradle-wrapper = "8.1.1"
 # https://kotlinlang.org/docs/releases.html
 kotlin-language = "2.0.20"