Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/dev-publish-plugin/api/dev-publish-plugin.api
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
13 changes: 13 additions & 0 deletions modules/dev-publish-plugin/src/main/kotlin/DevPublishPlugin.kt
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,19 @@ constructor(
): DevPublishPluginExtension {
return create<DevPublishPluginExtension>(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/")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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<String>

/**
* Directory holding the generated metadata file that records the [devMavenRepo] location.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,24 @@ class DevMavenRepoTrackedFilesPathsTest : FunSpec({
)
}
}

context("when the extension adds an excluded file pattern") {
val project = project()
project.extensions.getByType<DevPublishPluginExtension>()
.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 {
Expand Down
Loading