Avoid snapshotting sourceLink.localDirectory input #2807
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A typical use case in a project with complex source root setup is to set sourceLink.localDirectory to the root of the project checkout dir and remoteUrl to the root of the project VCS url respectively. However, since this property was marked as InputDirectory, in that case Gradle snapshotted hashes of all files in this entire project directory before running the Dokka task (including for example .git and .gradle directories). This could be very slow in big projects and also result in various Gradle warnings. Now localDirectory is not an input property, but its relativized path is stored in another read-only input string property. Therefore, it invalidates task outputs when its value changes, but not when any content inside it.
vmishenev
approved these changes
Jan 10, 2023
runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/GradleSourceLinkBuilder.kt
Outdated
Show resolved
Hide resolved
...adle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicCachingIntegrationTest.kt
Outdated
Show resolved
Hide resolved
|
Note: I assigned this PR to me because I would have liked to hit merge myself in order to correct the message of the squashed commit. |
Oh, sorry, will bear this in mind for next time 👍 Never seen assigns used in that way and we don't use the field ourselves, so it didn't trigger anything in my brain, I just assumed you assigned it to yourself automatically. I thought about leaving the more detailed comment in the commit description, but I felt like in-code comments captured it well, if that's what you wanted to add. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A typical use case in a project with complex source root setup is to set
sourceLink.localDirectoryto the root of the project checkout dir and remoteUrl to the root of the project VCS url respectively.However, since this property was marked as
InputDirectory, in that case Gradle snapshotted hashes of all files in this entire project directory before running the Dokka task (including for example .git and .gradle directories). This could be very slow in big projects and also result in various Gradle warnings.Now
localDirectoryis not an input property, but its relativized path is stored in another read-only input string property. Therefore, it invalidates task outputs when its value changes, but not when any content inside it.