Use directory name as project name for libs #115720
Conversation
The libs projects are configured to all begin with `elasticsearch-`. While this is desireable for the artifacts to contain this consistent prefix, it means the project names don't match up with their directories. Additionally, it creates complexities for subproject naming that must be manually adjusted. This commit adjusts the project names for those under libs to be their directory names. The resulting artifacts for these libs are kept the same, all beginning with `elasticsearch-`.
|
Pinging @elastic/es-delivery (Team:Delivery) |
| } | ||
| c.getOutputs().doNotCacheIf("BWC distribution caching is disabled for local builds", task -> BuildParams.isCi() == false); | ||
| c.getArgs().add(projectPath.replace('/', ':') + ":" + assembleTaskName); | ||
| c.getArgs().add("-p"); |
There was a problem hiding this comment.
By using the directory name (which hasn't changed) this allows for bwc builds to run, even though this change has not yet been backported.
|
|
||
| testImplementation(project(":test:framework")) { | ||
| exclude group: 'org.elasticsearch', module: 'elasticsearch-core' | ||
| exclude group: 'org.elasticsearch', module: 'core' |
There was a problem hiding this comment.
Does the gradle "module name" matter? This PR produces the same artifact ids, though the "name" attribute in the pom is different. Is there a way to control this module name in gradle? I could only find archivesName which we set as the artifactId.
There was a problem hiding this comment.
The "name" is purely descriptive so I think it's fine if they are different. So long as the artifactId is the same we won't have to deal with updating dependencies.
name: Projects tend to have conversational names, beyond the artifactId. The Sun engineers did not refer to their project as "java-1.5", but rather just called it "Tiger". Here is where to set that value.
rjernst
added
v8.17.0
auto-backport
| ':server:generatePluginsList', | ||
| ':generateProviderImpls', | ||
| ':libs:elasticsearch-native:elasticsearch-native-libraries:extractLibs', | ||
| ':libs:native:libraries:extractLibs', |
There was a problem hiding this comment.
Why has elasticsearch-native-libraries becomes simply libraries?
There was a problem hiding this comment.
It's just the local project name. Before we manually changed it to elasticsearch-native-libraries in settings.gradle. Now the artifact remains the same (set recursively in libs/build.gradle), but the local name is simplified.
libs/build.gradle
Outdated
| } | ||
|
|
||
| if (project.name == 'log4j') { | ||
| return |
There was a problem hiding this comment.
Can we just wrap the last bit in a conditional. These conditionals that rely on returns are very easy to get removed, or other logic being added below that should apply, but doesn't.
libs/build.gradle
Outdated
| apply plugin: 'base' | ||
|
|
||
| def baseProject = project | ||
| def baseName = "elasticsearch-${it.name}" |
There was a problem hiding this comment.
The term "base name" doesn't really make sense here anymore. Can we call this artifactId instead? I think that describes what where' trying to influence here.
libs/build.gradle
Outdated
| archivesName = baseName | ||
| } | ||
| subprojects { | ||
| plugins.withType(JavaPlugin).whenPluginAdded { |
There was a problem hiding this comment.
I'm not gonna lie, I struggle to follow what we're trying to do here. Can we at least add some clarifying comments here to convey not just what we're doing, but why this is necessary?
There was a problem hiding this comment.
I added comments for the entire section explaining what we are doing.
elasticsearchmachine
added
the
serverless-linked
|
@mark-vieira I believe this is all working now and I've addressed your comments. |
💔 Backport failed
You can use sqren/backport to manually backport by running |
The libs projects are configured to all begin with `elasticsearch-`. While this is desireable for the artifacts to contain this consistent prefix, it means the project names don't match up with their directories. Additionally, it creates complexities for subproject naming that must be manually adjusted. This commit adjusts the project names for those under libs to be their directory names. The resulting artifacts for these libs are kept the same, all beginning with `elasticsearch-`.
* Use directory name as project name for libs (#115720) The libs projects are configured to all begin with `elasticsearch-`. While this is desireable for the artifacts to contain this consistent prefix, it means the project names don't match up with their directories. Additionally, it creates complexities for subproject naming that must be manually adjusted. This commit adjusts the project names for those under libs to be their directory names. The resulting artifacts for these libs are kept the same, all beginning with `elasticsearch-`. * fixes
The libs projects are configured to all begin with `elasticsearch-`. While this is desireable for the artifacts to contain this consistent prefix, it means the project names don't match up with their directories. Additionally, it creates complexities for subproject naming that must be manually adjusted. This commit adjusts the project names for those under libs to be their directory names. The resulting artifacts for these libs are kept the same, all beginning with `elasticsearch-`.
3 participants
The libs projects are configured to all begin with
elasticsearch-. While this is desireable for the artifacts to contain this consistent prefix, it means the project names don't match up with their directories. Additionally, it creates complexities for subproject naming that must be manually adjusted.This commit adjusts the project names for those under libs to be their directory names. The resulting artifacts for these libs are kept the same, all beginning with
elasticsearch-.