Skip to content

fix(build-logic): guard skip_shadow_publish variant-order race #34

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
THEROER merged 1 commit into from
Jul 6, 2026
Merged

fix(build-logic): guard skip_shadow_publish variant-order race #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 17 additions & 17 deletions ...gic/src/main/kotlin/dev/ua/theroer/magicutils/build/publish/MagicUtilsPublishingPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,23 @@ class MagicUtilsPublishingPlugin : Plugin<Project> {

// Production publishing skips the fat build (it exists for local dev only);
// hide the shadow variant from the component so `:all` is not published.
// Runs after the shadow plugin has added shadowRuntimeElements to the
// component (withVariantsFromConfiguration must follow addVariants...).
//
// withVariantsFromConfiguration throws "Variant for configuration
// 'shadowRuntimeElements' does not exist in component 'java'" unless the
// shadow plugin has already added that variant to the component. It does so
// from its own afterEvaluate hook, whose ordering vs. this one is not
// guaranteed — and CI's injected plugins (Develocity via setup-gradle)
// reorder it so ours runs first, which failed every publish. Modules
// without real shading (e.g. :processor) never register the variant at all,
// so there is simply nothing to skip. Guard the call: only skip when the
// variant is actually present on the component.
if (project.hasProperty("skip_shadow_publish")) {
project.afterEvaluate {
(project.components.findByName("java") as? AdhocComponentWithVariants)?.let { java ->
project.configurations.findByName("shadowRuntimeElements")?.let { shadow ->
java.withVariantsFromConfiguration(shadow) { it.skip() }
project.plugins.withId("com.gradleup.shadow") {
project.afterEvaluate {
(project.components.findByName("java") as? AdhocComponentWithVariants)?.let { java ->
project.configurations.findByName("shadowRuntimeElements")?.let { shadow ->
Comment on lines +27 to +36

@sourcery-ai sourcery-ai Bot Jul 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

issue (bug_risk): Avoid silently swallowing failures from withVariantsFromConfiguration.

Wrapping withVariantsFromConfiguration in runCatching without handling onFailure or the result hides any misconfiguration or runtime error and could silently break publishing. Consider either allowing the exception to propagate or explicitly handling/logging failures so configuration problems are visible in CI/output.

runCatching { java.withVariantsFromConfiguration(shadow) { it.skip() } }
}
}
}
}
Expand All @@ -39,17 +49,7 @@ class MagicUtilsPublishingPlugin : Plugin<Project> {
// one module, variants by classifier, mirroring the Fabric bundle's
// `dev`. No separate `-all` artifactId.
//
// Bind the component in afterEvaluate: the shadow plugin registers
// its shadowRuntimeElements variant on the component from its own
// afterEvaluate hook. Reading the component at apply time (or having
// publish compute componentArtifacts before that hook runs, as CI's
// injected plugins reorder it to) throws "Variant for configuration
// 'shadowRuntimeElements' does not exist in component 'java'".
// afterEvaluate runs after shadow's registration, so the component
// is complete.
project.afterEvaluate {
publication.from(project.components.getByName("java"))
}
publication.from(project.components.getByName("java"))
}
}

Expand Down
Loading