Gradle: set file encoding globally, set it for all javadoc tasks #259

Author: greenrobot-team

.gitignore

@@ -12,7 +12,6 @@ gen/
 target/
 out/
 classes/
-gradle.properties
 
 # Local build properties
 build.properties

.gitlab-ci.yml

@@ -16,9 +16,8 @@ variables:
   # Disable the Gradle daemon. Gradle may run in a Docker container with a shared
   # Docker volume containing GRADLE_USER_HOME. If the container is stopped after a job
   # Gradle daemons may get killed, preventing proper clean-up of lock files in GRADLE_USER_HOME.
-  # Configure file.encoding to always use UTF-8 when running Gradle.
   # Use low priority processes to avoid Gradle builds consuming all build machine resources.
-  GRADLE_OPTS: "-Dorg.gradle.daemon=false -Dfile.encoding=UTF-8 -Dorg.gradle.priority=low"
+  GRADLE_OPTS: "-Dorg.gradle.daemon=false -Dorg.gradle.priority=low"
   GITLAB_REPO_ARGS: "-PgitlabUrl=$CI_SERVER_URL -PgitlabPrivateTokenName=Deploy-Token -PgitlabPrivateToken=$OBX_READ_PACKAGES_TOKEN"
   GITLAB_PUBLISH_ARGS: "-PgitlabPublishTokenName=Job-Token -PgitlabPublishToken=$CI_JOB_TOKEN"
   CENTRAL_PUBLISH_ARGS: "-PsonatypeUsername=$SONATYPE_USER -PsonatypePassword=$SONATYPE_PWD"

build.gradle.kts

@@ -87,6 +87,13 @@ allprojects {
             cacheChangingModulesFor(0, "seconds")
         }
     }
+
+    tasks.withType<Javadoc>().configureEach {
+        // To support Unicode characters in API docs force the javadoc tool to use UTF-8 encoding.
+        // Otherwise, it defaults to the system file encoding. This is required even though setting file.encoding
+        // for the Gradle daemon (see gradle.properties) as Gradle does not pass it on to the javadoc tool.
+        options.encoding = "UTF-8"
+    }
 }
 
 tasks.wrapper {

gradle.properties

@@ -0,0 +1,8 @@
+# Gradle configuration
+# https://docs.gradle.org/current/userguide/build_environment.html
+
+# To support Unicode characters in source code, set UTF-8 as the file encoding for the Gradle daemon,
+# which will make most Java tools use it instead of the default system file encoding. Note that for API docs,
+# the javadoc tool must be configured separately, see the root build script.
+# https://docs.gradle.org/current/userguide/common_caching_problems.html#system_file_encoding
+org.gradle.jvmargs=-Dfile.encoding=UTF-8

objectbox-java/build.gradle

@@ -100,7 +100,6 @@ tasks.register('javadocForWeb', Javadoc) {
     destinationDir = file(javadocForWebDir)
 
     title = "ObjectBox Java ${version} API"
-    options.encoding = 'UTF-8' // Set UTF-8 encoding to support unicode characters used in docs
     options.overview = "$projectDir/src/web/overview.html"
     options.bottom = 'Available under the Apache License, Version 2.0 - <i>Copyright &#169; 2017-2024 <a href="https://objectbox.io/">ObjectBox Ltd</a>. All Rights Reserved.</i>'
 

tests/objectbox-java-test/build.gradle.kts

@@ -10,8 +10,6 @@ tasks.withType<JavaCompile> {
     // Note: use release flag instead of sourceCompatibility and targetCompatibility to ensure only JDK 8 API is used.
     // https://docs.gradle.org/current/userguide/building_java_projects.html#sec:java_cross_compilation
     options.release.set(8)
-    // Note: Gradle defaults to the platform default encoding, make sure to always use UTF-8 for UTF-8 tests.
-    options.encoding = "UTF-8"
 }
 
 // Produce Java 8 byte code, would default to Java 6.