Skip to content

Exclude changelog file from documentTest task inputs #2159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Goooler merged 5 commits into from
Aug 7, 2026
+7 −11
Merged

Exclude changelog file from documentTest task inputs #2159

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
71a4f01
Exclude docs/changes/README.md from documentTest task inputs
Goooler Aug 7, 2026
90e5336
Cleanups
Goooler Aug 7, 2026
5164c7c
Merge docsDir
Goooler Aug 7, 2026
909c09f
Merge branch 'main' into g/20260807/exclude-changelog
Goooler Aug 7, 2026
913e21b
Rearrange
Goooler Aug 7, 2026
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
18 changes: 7 additions & 11 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,18 +141,19 @@ dependencies {
lintChecks(libs.androidx.gradlePluginLints)
}

val docsDir = file("docs")

testing.suites {
getByName<JvmTestSuite>("test") { dependencies { implementation(libs.xmlunit) } }
register<JvmTestSuite>("documentTest") {
targets.configureEach {
testTask {
val docsDir =
file("docs").also {
if (!it.exists() || !it.isDirectory)
error("Docs dir $it does not exist or is not a directory.")
inputs.files(
fileTree(docsDir) {
// Changelog file doesn't contain code snippet to run.
exclude("changes/README.md")
}
// Add docs as an input directory to trigger ManualCodeSnippetTests re-run on changes.
inputs.dir(docsDir)
)
}
}
}
Expand Down Expand Up @@ -232,11 +233,6 @@ buildConfig {
buildConfigField("TEST_GRADLE_VERSION", testGradleVersion)
}
sourceSets.named("documentTest") {
val docsDir =
file("docs").also {
if (!it.exists() || !it.isDirectory)
error("Docs dir $it does not exist or is not a directory.")
}
Comment on lines -235 to -239

@Goooler Goooler Aug 7, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shadow/src/documentTest/kotlin/com/github/jengelman/gradle/plugins/shadow/DocCodeSnippetTest.kt

Line 17 in 9fec3d6

check(langExecutables.sumOf { it.size } > 0) { "No code snippets found." }

buildConfigField("DOCS_DIR", docsDir.absolutePath)
}
}
Expand Down