Gradle multi-project naming: How can I set a property (e.g. baseName) for all subprojects?

Question

I started using Gradle for multi-projects. However, the Gradle manual does not give many hints for the best practice regarding the naming of subprojects.

I have the multiproject with the name 'datalogger' that consists of two subprojects 'core' and 'entries':

- datalogger
--- core
--- entries

When I build the project, I get the jars 'core-1.0.jar' and 'entries-1.0.jar'. How do I manage that the naming is 'datalogger-core-1.0.jar' and 'datalogger-entries-1.0.jar' in a generic way? I know, I could change the name of the folders as follows:

- datalogger
--- datalogger-core
--- datalogger-entries

But that would not be regarded as good approach, I assume. I could also manually change the archivesBaseName of each project. But I would rather find a way to do this in a generic way, as mentioned before.

[Spring](https://github.com/SpringSource/spring-framework) does it by naming every subproject spring-xxx. [hibernate](https://github.com/hibernate/hibernate-orm) does it this way as well. — JB Nizet, Feb 03 '13 at 16:17
@JBNizet: Thanks, maybe this is not bad practice as i assumed in the first place. It could actually solve all problems. — Martin L., Feb 03 '13 at 17:30

score 9 · Accepted Answer · answered Feb 03 '13 at 16:18

9

subprojects {
    tasks.withType(Jar) {
        baseName = "datalogger-$project.name"
    }
}

Alternatively, you could set archivesBaseName in a similar way.

answered Feb 03 '13 at 16:18

Peter Niederwieser

121,412
21
324
259

2

The maven-publishing task ignores archivesBaseName – cmcginty Aug 09 '13 at 03:08

score 1 · Answer 2 · edited May 23 '17 at 10:33

1

We're handling this by renaming the subprojects, new names will be taken into account when creating/naming your jars: ref: how to rename the project in gradle instead of using folder name?

include 'xxx', 'yyy'
rootProject.children.each { it.name = rootProject.name + it.name }

edited May 23 '17 at 10:33

Community

1
1

answered Feb 04 '13 at 11:19

roomsg

1,811
16
22

score 0 · Answer 3 · answered Dec 07 '22 at 19:12

0

For Kotlin: in the root project's build file:

subprojects {
    tasks.withType<Jar> {
        archiveBaseName.set("${rootProject.name}-${project.name}")
    }
}

answered Dec 07 '22 at 19:12

jck

170
1
7

Gradle multi-project naming: How can I set a property (e.g. baseName) for all subprojects?

3 Answers3