Make the preprocessing tasks for workflow files cacheable (#2157)

Author: Vampire

.github/workflows/branches-and-prs.main.kts

@@ -84,7 +84,13 @@ workflow(
     with(__FILE__.parentFile.resolve("../codecov.yml")) {
         readText()
             .replace("after_n_builds:.*+$".toRegex(), "after_n_builds: ${matrix.size}")
-            .let(::writeText)
+            .let {
+                parentFile
+                    .resolve("../build/")
+                    .apply { mkdirs() }
+                    .resolve("codecov_branches-and-prs.yml")
+                    .writeText(it)
+            }
     }
     job(
         id = "build-and-verify",

.github/workflows/release.main.kts

@@ -55,7 +55,13 @@ workflow(
     with(__FILE__.parentFile.resolve("../codecov.yml")) {
         readText()
             .replace("after_n_builds:.*+$".toRegex(), "after_n_builds: ${matrix.size}")
-            .let(::writeText)
+            .let {
+                parentFile
+                    .resolve("../build/")
+                    .apply { mkdirs() }
+                    .resolve("codecov_release.yml")
+                    .writeText(it)
+            }
     }
     val buildAndVerify = job(
         id = "build-and-verify",

build-logic/preprocess-workflows/src/main/groovy/org/spockframework/gradle/PreprocessGithubWorkflow.groovy

@@ -8,22 +8,28 @@ import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.*
 import org.gradle.jvm.toolchain.JavaLauncher
+import org.gradle.work.NormalizeLineEndings
 import org.gradle.workers.WorkerExecutor
 
 import javax.inject.Inject
 
 @CompileStatic
+@CacheableTask
 abstract class PreprocessGithubWorkflow extends DefaultTask {
   @InputFile
+  @NormalizeLineEndings
+  @PathSensitive(PathSensitivity.RELATIVE)
   abstract RegularFileProperty getWorkflowScript()
 
   @InputFiles
+  @NormalizeLineEndings
+  @PathSensitive(PathSensitivity.RELATIVE)
   abstract ConfigurableFileCollection getImportedFiles()
 
-  @InputFiles
+  @Classpath
   abstract ConfigurableFileCollection getKotlinCompilerClasspath()
 
-  @InputFiles
+  @Classpath
   abstract ConfigurableFileCollection getMainKtsClasspath()
 
   @Nested

build-logic/preprocess-workflows/src/main/groovy/org/spockframework/gradle/PreprocessWorkflowsPlugin.groovy

@@ -20,6 +20,7 @@ import groovy.transform.CompileStatic
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.artifacts.VersionCatalogsExtension
+import org.gradle.api.tasks.Delete
 import org.gradle.jvm.toolchain.JavaLanguageVersion
 import org.gradle.jvm.toolchain.JavaToolchainService
 
@@ -62,6 +63,12 @@ class PreprocessWorkflowsPlugin implements Plugin<Project> {
           it.languageVersion.set(JavaLanguageVersion.of(17))
         })
       }
+      def deleteWorkflowYaml = project.tasks.register("delete${pascalCasedWorkflowName}WorkflowYaml", Delete) {
+        it.delete(preprocessWorkflow.flatMap { it.workflowFile })
+      }
+      preprocessWorkflow.configure {
+        it.dependsOn(deleteWorkflowYaml)
+      }
       project.pluginManager.withPlugin('io.spring.nohttp') {
         // iff both tasks are run, workflow files should be generated before checkstyle check
         project.tasks.named('checkstyleNohttp') {

build.gradle

@@ -404,3 +404,40 @@ def configureGroovydoc(TaskProvider groovydoc) {
     include "spock/**"
   }
 }
+
+def preprocessBranchesAndPrsWorkflowCodecovOutput = layout.buildDirectory.file('codecov_branches-and-prs.yml')
+def preprocessReleaseWorkflowCodecovOutput = layout.buildDirectory.file('codecov_release.yml')
+
+def copyCodecovConfig = tasks.register('copyCodecovConfig') {
+  doLast {
+    copy {
+      from(
+        [
+          preprocessBranchesAndPrsWorkflowCodecovOutput,
+          preprocessReleaseWorkflowCodecovOutput
+        ].max {it.get().asFile.lastModified() })
+      into('.github')
+      rename { 'codecov.yml' }
+    }
+  }
+}
+
+tasks.preprocessBranchesAndPrsWorkflow {
+  inputs
+    .file('.github/codecov.yml')
+    .normalizeLineEndings()
+    .withPathSensitivity(PathSensitivity.RELATIVE)
+    .withPropertyName('codecovConfig')
+  outputs.file(preprocessBranchesAndPrsWorkflowCodecovOutput).withPropertyName('codecovConfig')
+  finalizedBy(copyCodecovConfig)
+}
+
+tasks.preprocessReleaseWorkflow {
+  inputs
+    .file('.github/codecov.yml')
+    .normalizeLineEndings()
+    .withPathSensitivity(PathSensitivity.RELATIVE)
+    .withPropertyName('codecovConfig')
+  outputs.file(preprocessReleaseWorkflowCodecovOutput).withPropertyName('codecovConfig')
+  finalizedBy(copyCodecovConfig)
+}