Skip to content
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

Jump to bottom

Dokkatoo uses typesafe Attributes, which are bugged in Gradle #214

Open
aSemy opened this issue Apr 5, 2024 · 4 comments
Open

Dokkatoo uses typesafe Attributes, which are bugged in Gradle #214

aSemy opened this issue Apr 5, 2024 · 4 comments
Labels
blocked-by:Gradle Blocked by a bug/missing feature in Gradle bug Something isn't working

Comments

@aSemy
Copy link
Contributor

aSemy commented Apr 5, 2024

Gradle recommends using typesafe attributes to share files. However, these are fundamentally bugged and will not work in some situations.

I will implement a workaround, but I am opening this issue to track a real fix, dependent on whether Gradle can acknowledge and fix the issue.

This issue might be the cause of #165 and #170.

Thank you @kelvSYC for the report and reproducer! #211
@aSemy aSemy added bug Something isn't working blocked-by:Gradle Blocked by a bug/missing feature in Gradle labels Apr 5, 2024
aSemy added a commit that referenced this issue Apr 5, 2024
@aSemy
workaround bugged Gradle attributes
b79e769 
- use `Attribute<String>` instead of typed attributes.
- change the Dokkatoo attributes to be value classes, so they can still be used mostly type-safely.
- Improve logging (include hashcodes) and error reporting.

#214
@aSemy aSemy mentioned this issue Apr 5, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Apr 5, 2024
@aSemy
workaround bugged Gradle attributes (#215)
4e0f7a7 
* workaround bugged Gradle attributes

- use `Attribute<String>` instead of typed attributes.
- change the Dokkatoo attributes to be value classes, so they can still be used mostly type-safely.
- Improve logging (include hashcodes) and error reporting.

#214

* Update modules/dokkatoo-plugin/src/main/kotlin/internal/gradleUtils.kt
@CLOVIS-AI
Copy link
Contributor

Do you know if this problem also applies to Dokka v2?

@aSemy
Copy link
Contributor Author

aSemy commented Dec 20, 2024

Do you know if this problem also applies to Dokka v2?

No, Dokkatoo and DGPv2 now use string-based attributes, which aren't affected.

@CLOVIS-AI
Copy link
Contributor

Uh. That's strange, because I'm still seeing #170 with the latest Dokkatoo version.

Once I migrate to Dokka v2, I'll recreate the issue there.

@aSemy
Copy link
Contributor Author

aSemy commented Jan 4, 2025

Ah yeah, #170 won't be helped by string-based attributes. A fix requires a more significant rewrite of how DGP shares files between subprojects.

I tried a workaround, but it doesn't work because of an (extremely confusing and undocumented) feature in Gradle gradle/gradle#30921

#170 will be fixed in DGP at some point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
blocked-by:Gradle Blocked by a bug/missing feature in Gradle bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@aSemy @CLOVIS-AI