MINOR: Move generated sources to build directory #16993
Conversation
.gitignore
Outdated
| **/src/generated | ||
| **/src/generated-test |
There was a problem hiding this comment.
Removing these ignores makes it more likely for people to accidentally commit the generated code, right?
WDYT about moving the directories but leaving the ignores in place for some time? If we merged my clean PR, that could give a window in which developers can clean up the old directories without ever thinking about them, and later we can finally remove the ignores and the extra clean.
There was a problem hiding this comment.
The reason I wanted to remove it was so we could do a simple git clean to remove the files from the old location. However, not ignoring them does make it more likely for someone to commit them.
I think your plan makes sense. Basically if we move the files to "build", but keep the additional clean logic you've added, ./gradlew clean should clear out both locations.
There was a problem hiding this comment.
1 to @gharris1727 to leave the ignores in place. Otherwise, people could commit the generated code unexpectedly when testing 3.x branches and trunk branch.
There was a problem hiding this comment.
@mumrah thanks for this patch. Could you please remove unused path (src/generated/java)` from core module (https://github.com/apache/kafka/blob/trunk/build.gradle#L1261). That should be included by #16019 but I overlook it ...
.gitignore
Outdated
| **/src/generated | ||
| **/src/generated-test |
There was a problem hiding this comment.
1 to @gharris1727 to leave the ignores in place. Otherwise, people could commit the generated code unexpectedly when testing 3.x branches and trunk branch.
|
Reviewers: Chia-Ping Tsai <[email protected]>
Reviewers: Chia-Ping Tsai <[email protected]>
Gradle does not recommend putting generated and non-generated sources in the same directory. This can disturb the caching mechanism. This patch puts the generated sources into the "build" dir.
After merging, the old generated sources will still be around but should not affect the build or local development. A
./gradlew cleanshould remove any old or new generated sources.https://discuss.gradle.org/t/right-way-to-generate-sources-in-gradle-7/41141/2