diff --git a/modules/dev-publish-plugin/api/dev-publish-plugin.api b/modules/dev-publish-plugin/api/dev-publish-plugin.api index f6b8450..9465393 100644 --- a/modules/dev-publish-plugin/api/dev-publish-plugin.api +++ b/modules/dev-publish-plugin/api/dev-publish-plugin.api @@ -17,6 +17,7 @@ public final class dev/adamko/gradle/dev_publish/DevPublishPlugin$Companion { public abstract class dev/adamko/gradle/dev_publish/DevPublishPluginExtension { public final fun dependency ()Lorg/gradle/api/provider/Provider; public abstract fun getDevMavenRepo ()Lorg/gradle/api/file/DirectoryProperty; + public abstract fun getExcludedDevMavenRepoFilePatterns ()Lorg/gradle/api/provider/SetProperty; } public abstract class dev/adamko/gradle/dev_publish/data/PublicationData : org/gradle/api/Named { diff --git a/modules/dev-publish-plugin/src/main/kotlin/DevPublishPlugin.kt b/modules/dev-publish-plugin/src/main/kotlin/DevPublishPlugin.kt index 4ab61fb..39fe450 100644 --- a/modules/dev-publish-plugin/src/main/kotlin/DevPublishPlugin.kt +++ b/modules/dev-publish-plugin/src/main/kotlin/DevPublishPlugin.kt @@ -137,6 +137,19 @@ constructor( ): DevPublishPluginExtension { return create(DEV_PUB__EXTENSION_NAME).apply { devMavenRepo.convention(layout.buildDirectory.dir(DEV_PUB__MAVEN_REPO_DIR)) + val defaultExcludedDevMavenRepoFilePatterns = + setOf( + "**/maven-metadata.xml*", + "**/*.asc", + "**/*.sig", + "**/*.md5", + "**/*.sha1", + "**/*.sha256", + "**/*.sha512", + ) + excludedDevMavenRepoFilePatterns.convention(defaultExcludedDevMavenRepoFilePatterns) + // use `set()` as a workaround for https://github.com/gradle/gradle/issues/18352#issuecomment-925080375 + excludedDevMavenRepoFilePatterns.set(defaultExcludedDevMavenRepoFilePatterns) val tmpDir = layout.buildDirectory.dir("tmp/.$DEV_PUB__MAVEN_REPO_DIR/") diff --git a/modules/dev-publish-plugin/src/main/kotlin/DevPublishPluginExtension.kt b/modules/dev-publish-plugin/src/main/kotlin/DevPublishPluginExtension.kt index 415639c..f7dbcb2 100644 --- a/modules/dev-publish-plugin/src/main/kotlin/DevPublishPluginExtension.kt +++ b/modules/dev-publish-plugin/src/main/kotlin/DevPublishPluginExtension.kt @@ -6,6 +6,7 @@ import org.gradle.api.file.ConfigurableFileCollection import org.gradle.api.file.DirectoryProperty import org.gradle.api.provider.Property import org.gradle.api.provider.Provider +import org.gradle.api.provider.SetProperty /** * Settings for controlling the behaviour of [DevPublishPlugin] and its tasks. @@ -51,6 +52,15 @@ abstract class DevPublishPluginExtension */ abstract val devMavenRepo: DirectoryProperty + /** + * Patterns of files in [devMavenRepo] that are ignored when checking if tests that depend on it are up-to-date. + * Exclude files that change on every build, but that tests don't use, such as SBOMs. + * See [org.gradle.api.tasks.util.PatternFilterable] for syntax. + * + * Default: Maven metadata (`maven-metadata.xml`), checksums, and signatures. + */ + abstract val excludedDevMavenRepoFilePatterns: SetProperty + /** * Directory holding the generated metadata file that records the [devMavenRepo] location. * diff --git a/modules/dev-publish-plugin/src/main/kotlin/tasks/DevPublishTasksContainer.kt b/modules/dev-publish-plugin/src/main/kotlin/tasks/DevPublishTasksContainer.kt index ba8613b..3b7e2e1 100644 --- a/modules/dev-publish-plugin/src/main/kotlin/tasks/DevPublishTasksContainer.kt +++ b/modules/dev-publish-plugin/src/main/kotlin/tasks/DevPublishTasksContainer.kt @@ -70,17 +70,7 @@ class DevPublishTasksContainer( } } ) - excludedDevMavenRepoFilePatterns.convention( - setOf( - "**/maven-metadata.xml*", - "**/*.asc", - "**/*.sig", - "**/*.md5", - "**/*.sha1", - "**/*.sha256", - "**/*.sha512", - ) - ) + excludedDevMavenRepoFilePatterns.convention(devPubExtension.excludedDevMavenRepoFilePatterns) stateDir.convention( objects.directoryProperty().fileValue(temporaryDir.resolve("state")) ) diff --git a/modules/dev-publish-plugin/src/main/kotlin/tasks/GenerateDevPublishMetadataTask.kt b/modules/dev-publish-plugin/src/main/kotlin/tasks/GenerateDevPublishMetadataTask.kt index e36d536..e574059 100644 --- a/modules/dev-publish-plugin/src/main/kotlin/tasks/GenerateDevPublishMetadataTask.kt +++ b/modules/dev-publish-plugin/src/main/kotlin/tasks/GenerateDevPublishMetadataTask.kt @@ -90,8 +90,7 @@ constructor( } /** - * Patterns of files to exclude from the dev Maven repository up-to-date check. - * See [org.gradle.api.tasks.util.PatternFilterable] for syntax. + * @see dev.adamko.gradle.dev_publish.DevPublishPluginExtension.excludedDevMavenRepoFilePatterns */ @get:Internal @DevPublishInternalApi diff --git a/modules/dev-publish-plugin/src/test/kotlin/DevMavenRepoTrackedFilesPathsTest.kt b/modules/dev-publish-plugin/src/test/kotlin/DevMavenRepoTrackedFilesPathsTest.kt index 85477e0..512096f 100644 --- a/modules/dev-publish-plugin/src/test/kotlin/DevMavenRepoTrackedFilesPathsTest.kt +++ b/modules/dev-publish-plugin/src/test/kotlin/DevMavenRepoTrackedFilesPathsTest.kt @@ -105,6 +105,24 @@ class DevMavenRepoTrackedFilesPathsTest : FunSpec({ ) } } + + context("when the extension adds an excluded file pattern") { + val project = project() + project.extensions.getByType() + .excludedDevMavenRepoFilePatterns.add("**/*.spdx.json") + writeRepoFiles( + project, + "foo/lib/maven-metadata.xml", + "foo/lib/1.0.0/lib-1.0.0.jar", + "foo/lib/1.0.0/lib-1.0.0.spdx.json", + ) + + test("expect the added and default patterns are excluded") { + project.tasks.generateDevPublishMetadata.shouldHaveTrackedFilesPaths( + "foo/lib/1.0.0/lib-1.0.0.jar", + ) + } + } }) { companion object { private fun project(): Project {