Import sources for javadoc through a dependency #1461
Conversation
Add configurations for importing and exporting source directories Add a sources configuration to add another project's source to the current project's javadoc. Add a sourceElements configuration to register all java source directories in the project under so they may be picked up by other projects.
| @@ -200,6 +235,15 @@ class BuildPlugin implements Plugin<Project> { | |||
| project.sourceCompatibility = '1.8' | |||
| project.targetCompatibility = '1.8' | |||
|
|
|||
| // TODO: Remove all root project distribution logic. It should exist in a separate dist project. | |||
There was a problem hiding this comment.
This is a problem that I'm working on addressing in another PR. The root project is all sorts of messed up because it depends (without using dependencies in a lot of cases 😱) on all the subprojects to build an uber jar. This uberjar/dist zip should be generated in a subproject instead of the root project, using dependencies, configurations, and all other appropriate build script hygiene to resolve the cross project links.
…classpath have everything already
| // Import source configuration | ||
| Configuration sources = project.configurations.create("sources") | ||
| sources.canBeConsumed = false | ||
| sources.canBeResolved = true |
There was a problem hiding this comment.
this is be false too ? the sources shouldn't be resolved since they should only be declared as a single project reference ?
There was a problem hiding this comment.
Hmm, gradle does not seem to like this. In order for Gradle to convert the project dependency into actual files it needs to resolve the configuration. It needs to do this for the sources jar, and any time a file collection that contains the configuration is mutated.
buildSrc/src/main/groovy/org/elasticsearch/hadoop/gradle/BuildPlugin.groovy
Outdated
Show resolved
Hide resolved
| if (project != project.rootProject) { | ||
| SourceSet mainSourceSet = project.sourceSets.main | ||
| FileCollection javaSourceDirs = mainSourceSet.java.sourceDirectories | ||
| javaSourceDirs.each { File srcDir -> |
There was a problem hiding this comment.
is this loop correct ? I would have expected to see something like:
project.getArtifacts().add('sourceElements', mainSourceSet.java.sourceDirectories)
(no loop)
There was a problem hiding this comment.
I don't believe that will work since sourceDirectories is a FileCollection. The ArtifactHandler.add() doesn't accept collections. You need to add the directories individually.
That said, because of this, we are open to configuration ordering issues here. So any additional source directories need to be added before this code runs.
There was a problem hiding this comment.
Yeah, I wasn't able to find anything on FileCollections that allows you to listen for changes like other domain object collections. I think anything outside of the default java directory needs to be added to the source set explicitly, and thus should be getting added to the sourceElements configuration explicitly as well.
|
|
||
| // Export generated Java code from the genjavadoc compiler plugin | ||
| artifacts { | ||
| sourceElements(project.file("$buildDir/generated/java")) { |
There was a problem hiding this comment.
does adding the sourceElements here conflict with plugin addition ? ( I don't know if it is additive or a replacement)
There was a problem hiding this comment.
This isn't adding a configuration. It's adding an artifact to the existing sourceElements configuration.
There was a problem hiding this comment.
Not sure what you mean by this question. Do you mean the scala compiler plugin or the build plugin?
Edit: Github did not refresh before Mark answered :P
| if (project != project.rootProject) { | ||
| SourceSet mainSourceSet = project.sourceSets.main | ||
| FileCollection javaSourceDirs = mainSourceSet.java.sourceDirectories | ||
| javaSourceDirs.each { File srcDir -> |
There was a problem hiding this comment.
I don't believe that will work since sourceDirectories is a FileCollection. The ArtifactHandler.add() doesn't accept collections. You need to add the directories individually.
That said, because of this, we are open to configuration ordering issues here. So any additional source directories need to be added before this code runs.
|
|
||
| // Export generated Java code from the genjavadoc compiler plugin | ||
| artifacts { | ||
| sourceElements(project.file("$buildDir/generated/java")) { |
There was a problem hiding this comment.
This isn't adding a configuration. It's adding an artifact to the existing sourceElements configuration.
sources -> additionalSources
Add configurations for importing and exporting source directories Add an additionalSources configuration to add another project's source to the current project's javadoc. Add a sourceElements configuration to register all java source directories in the project under so they may be picked up by other projects.
|
Relates #1423 |
We embed project code from the MR project into each and every integration Project in ES-Hadoop. When generating javadocs, we directly reference the mr project's source sets to pull their contents into the javadoc tool as an input.
This becomes a problem when a downstream project depends on java source code that is generated by a task. A specific instance of this problem arises when splitting the Spark core and SQL projects apart. The Spark projects take advantage of a compiler plugin to generate java sources specifically to be used with the Javadoc tool. These generated sources must be transmitted from the Spark core projects to the Spark SQL projects so that they may be bundled together in the same documentation package.
This PR adds configurations for importing and exporting source directories. It adds a
sourceElementsconfiguration that can be consumed by other projects. The build plugin then registers the main java source directories in the project with this configuration through the artifacts handler. The PR also adds asourcesconfiguration that can be resolved. Projects use this configuration to denote source code directories from other projects that are needed to generate the Javadocs and Sources jar.