Spring Boot 2 - Change Jar Name

Question

I am using Spring Boot 2 in my Gradle project to do a build to jar in Jenkins, and I would like to change the name of that jar file.

By default, Spring Boot 2 used the Gradle property rootProject.name, which can be set in the /settings.gradle file.

However, I would like to change the jar file name, without changing the rootProject.name.

Here are my bootJar and springBoot sections of the build.gradle file:

bootJar {
  launchScript()
}

.

springBoot {
  buildInfo {
    properties {
      artifact = "jarName"
      group = "groupName"
      name = "projectName"
      version = "1.0"
    }
  }
}

Note: artifact is not setting the jar name, as I expected it to, after reading: https://docs.spring.io/spring-boot/docs/current/gradle-plugin/reference/html/#integrating-with-actuator

The `artifact` build info property is, by default, derived from the base name of the `bootJar` or `bootWar` task not the other way around. If you configure it explicitly, the base name-based default will no longer be used and the explicit value will be used instead. The base name of the `bootJar` or `bootWar` task will be unaffected. — Andy Wilkinson, Nov 02 '18 at 17:47
@AndyWilkinson: Thanks! Removing `springBoot.buildInfo.properties.artifact` and adding `bootJar.baseName` worked! — Brandon Dudek, Nov 02 '18 at 18:04

score 70 · Answer 1 · edited Jan 16 '20 at 16:31

70

archiveFileName is the new hotness. Everything else is deprecated.

bootJar {
   archiveFileName = "${archiveBaseName.get()}.${archiveExtension.get()}"
}

or the Kotlin DSL equivalent:

tasks.getByName<org.springframework.boot.gradle.tasks.bundling.BootJar>("bootJar") {
   this.archiveFileName.set("${archiveBaseName.get()}.${archiveExtension.get()}")
}

See:

edited Jan 16 '20 at 16:31

checketts

14,167
10
53
82

answered Jun 07 '19 at 15:43

Planky

3,185
3
29
39

I was looking for the secret sauce to manipulate the template. As I am not a seasoned gradle handler, I forgot you have to `get()` the values. This is the answer for those who wish to have FULL control over the build name – hanzo2001 Jan 25 '21 at 15:49

score 14 · Answer 2 · edited Nov 02 '18 at 17:48

14

Since bootJar tasks extends Jar you can use archiveName to set name the directly:

bootJar {
   archiveName = 'whatever'
}

Have a look here.

edited Nov 02 '18 at 17:48

Andy Wilkinson

108,729
24
257
242

answered Nov 02 '18 at 17:12

Opal

81,889
28
189
210

Thanks. I did try that, as well as `jar{baseName 'whatever'}` and neither worked. (I think those only worked in SpringBoot 1.) – Brandon Dudek Nov 02 '18 at 17:37
1

This is almost right. The task that's customized needs to be `bootJar` rather than `jar` though. I have edited the answer accordingly. – Andy Wilkinson Nov 02 '18 at 17:47

score 11 · Accepted Answer · answered Nov 02 '18 at 18:08

11

Thanks to @AndyWilkinson for the answer!

bootJar {
  baseName "jarName"
  launchScript()
}

.

springBoot {
  buildInfo {
    properties {
      group = "groupName"
      name = "projectName"
      version = "1.0"
    }
  }
}

answered Nov 02 '18 at 18:08

Brandon Dudek

849
1
8
18

score 9 · Answer 4 · answered Apr 27 '20 at 14:21

9

You can also use:

tasks.bootJar {
    archiveFileName.set("app.jar")
}

Or with the jar-plugin

tasks.jar {
    archiveFileName.set("app.jar")
}

answered Apr 27 '20 at 14:21

mrclrchtr

948
10
14

score 8 · Answer 5 · answered Mar 08 '19 at 22:51

8

My goal was to remove version from the archive name. I did it this way:

bootJar {
   archiveName = "$baseName.$extension"
}

Now Gradle generates "project-name.jar" instead of "project-name-1.0-SNAPSHOT.jar". This solution is general and doesn't hardcode any particular archive name.

answered Mar 08 '19 at 22:51

naXa stands with Ukraine

35,493
19
190
259

4

The [archiveName](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveName) property is deprecated for some reason, but I found a simplier approach: `bootJar { archiveVersion = null }`. This overrides default value of [archiveVersion](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveVersion) property, which is equal to `project.version` by default. Jar task generates the final `archiveFileName` without version in this case. – Ruslan Stelmachenko Mar 15 '19 at 17:07

score 8 · Answer 6 · answered Nov 13 '19 at 09:03

For Gradle 6

bootJar {
    archiveBaseName = 'freeway-server'
    archiveVersion = '1.0.0'
    archiveFileName = 'freeway-server.jar'
}

For get:-

System.out.print(bootJar.getArchiveBaseName().get())
System.out.print(bootJar.getArchiveVersion().get())
System.out.print(bootJar.getArchiveFileName().get())

score 1 · Answer 7 · answered Sep 25 '20 at 22:35

Most people simply want to not have the version in the jar name, not change the name completely.

tasks.withType<org.springframework.boot.gradle.tasks.bundling.BootJar> {
    archiveVersion.set("")
}

will do it using Kotlin DSL. The final name is given by tasks.bootJar.get().archiveFileName.get().

score 0 · Answer 8 · answered Oct 30 '20 at 08:46

0

For me worked

project(':org.awseome.subproject') {
 jar() {
     archiveFileName = 'nameOfJar.jar'
 }
}

inside of main build.gradle. Used

Gradle 6.X Spring Boot 2.X

answered Oct 30 '20 at 08:46

Tristate

1,498
2
18
38

Spring Boot 2 - Change Jar Name

8 Answers8

Linked