Skip to content

exclude poko annotations as a runtime dependency #79

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

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

exclude poko annotations as a runtime dependency #79

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
8 changes: 8 additions & 0 deletions gradle/build-logic/convention/src/main/kotlin/AndroidLibraryPublishingConventionPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import me.tylerbwong.gradle.metalava.extension.MetalavaExtension
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.kotlin.dsl.configure
import org.gradle.kotlin.dsl.exclude

class AndroidLibraryPublishingConventionPlugin : Plugin<Project> {
override fun apply(target: Project): Unit = with(target) {
Expand All @@ -12,6 +13,13 @@ class AndroidLibraryPublishingConventionPlugin : Plugin<Project> {
apply("dev.drewhamilton.poko")
}

// exclude poko annotations dependency from runtime as it's only needed for compilation
configurations.all {
if (name.endsWith("RuntimeClasspath")) {
exclude(group = "dev.drewhamilton.poko")
}
}
Comment on lines +16 to +21
Copy link
Owner

Choose a reason for hiding this comment

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

Interesting. Can you help me understand why this is needed? Does it have to do with the way I'm applying poko above? If not, should all projects that use poko do this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the gradle plugin is adding the annotation dependency using implementation instead of compileOnly. It's seems that there's been some back-and-forth on trying to change that which apparently broke something drewhamilton/Poko#163.

Looking at the implementation an alternative would be to use a custom annotation and use compileOnly yourself, which would get rid of the extra pom metadata, but that seems like a lot to set up for something that should be pretty simple imo.

Copy link

Choose a reason for hiding this comment

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

👋 It was switched back to implementation in drewhamilton/Poko#212 because native targets apparently don't have the concept of compileOnly. If Telephoto is Android-only, this should be safe.

If you want to file an issue on Poko to make non-native targets use compileOnly by default (again), I wouldn't hate it!

Copy link

Choose a reason for hiding this comment

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

Ah, it's not Android-only. In that case you'll want to avoid applying this change to native targets.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Interesting, yeah I'm using this in an android project which is where I noticed the issue

Copy link
Contributor Author

Choose a reason for hiding this comment

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

so I checked and while this lib is multiplatform the only other platform is desktop jvm, which I would expect to behave the same way in terms of compilation right? I was going to submit a pr porting the sample app to desktop to prove this out but I couldn't get it working, 😕.

Copy link
Owner

Choose a reason for hiding this comment

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

Yea I only have desktop and android, but I want to add support for targets once coil becomes stable. I forgot to ask, what's the downside of not merging this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's not a huge deal but we are tracking our transitive dependencies and it was a surprising add, we did just put in an exclude for now.

implementation("me.saket.telephoto:zoomable:0.7.1") {
    exclude(group = "dev.drewhamilton.poko")
}

Copy link
Contributor Author

@evant evant Apr 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

created drewhamilton/Poko#328 as it might be better to tackle this upstream


// Used on CI to prevent publishing of non-snapshot versions.
tasks.register("throwIfVersionIsNotSnapshot") {
val libraryVersion = properties["VERSION_NAME"] as String
Expand Down
Loading