Want to specify jar name and version both in build.gradle

Question

I want to specify the jar name and version in build.gradle, so my build.gradle looks like below.

apply plugin: 'java'

version = "1.00.00"

 dependencies { 
     compile files('../../lib/abc.jar') 
} 

jar{
    manifest{
        attributes ("Fw-Version" : "2.50.00", "${parent.manifestSectionName}")

    }
    archiveName 'abc.jar'
}

So when I do

gradle clean build, what I was expecting was that the generated jar name would be abc-1.00.00.jar

But its not happening, the output jar name is getting as abc.jar only and its just ignoring the version. I want to specify both jar name and version, so how can I achieve that?

Read https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveName and https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:baseName — JB Nizet, Jul 14 '15 at 11:57

score 52 · Accepted Answer · edited Apr 30 '16 at 20:07

52

archiveName 'abc.jar' in your jar configuration is forcing the name to be 'abc.jar'. The default format for the jar name is ${baseName}-${appendix}-${version}-${classifier}.${extension}, where baseName is the name of your project and version is the version of the project. If you remove the archiveName line in your configuration you'll have the format you're after. If you want the name of the archive to be different from the project name set the baseName instead, e.g.

jar {
    manifest{
        attributes ("Fw-Version" : "2.50.00", "${parent.manifestSectionName}")
    }
    baseName 'abc'
}

See https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveName for more info on configuring the jar task.

edited Apr 30 '16 at 20:07

ThePyroEagle

153
12

answered Jul 14 '15 at 12:56

andyberry88

2,244
20
17

13

In 5.2.1 (current version) the property `baseName` is [deprecated](https://docs.gradle.org/5.2.1/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveName), while the replacement [`archiveBaseName`](https://docs.gradle.org/5.2.1/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveBaseName) is read-only. How do we do that in next version of Gradle? – Franklin Yu Mar 01 '19 at 14:43
2

`archiveFileName` – Sometowngeek Apr 14 '20 at 11:53

score 34 · Answer 2 · edited Jan 30 '20 at 21:44

34

For Gradle 5+

build.gradle groovy DSL

archiveBaseName = 'foo'

build.gradle.kts kotlin DSL

archivesBaseName.set("foo") // Notice the double quotes

edited Jan 30 '20 at 21:44

NonCreature0714

5,744
10
30
52

answered May 18 '19 at 09:39

Ahmed Kamal

2,660
3
21
36

5

there's a typo, should be 'archivesBaseName' – Gyowanny Pessatto Queiroz Aug 06 '19 at 11:28
3

@QuiltyKim Referring to the official docs, it's `archivesBaseName` with `s`. – Ahmed Kamal Sep 08 '19 at 06:37
3

`archivesBaseName` (with **s**) is a property in the Java plugin, not the Jar plugin. However the Jar plugin defaults to the value in `archivesBaseName` if `archiveBaseName` is not set. – Cavyn VonDeylen Sep 12 '19 at 13:24
1

Thanks for the Kotlin DSL hint. – Tobias Marschall Jan 05 '20 at 19:22
1

`archivesbaseName` hasn't the `set` method – Valentyn Hruzytskyi Mar 22 '22 at 15:41
"> Could not set unknown property 'archiveBaseName' for project ':lib' of type org.gradle.api.Project." With the 's' it works. – Pablo Pazos Aug 25 '23 at 15:55

score 7 · Answer 3 · answered Apr 04 '22 at 19:49

I wanted to achieve this in Kotlin DSL and this was the first question that came up on Google for me. The answers that involved Kotlin DSL did not work but I managed to find a solution.

Create this in the build.gradle.kts file:

tasks.jar {
  manifest {
    [THE LINES BELOW WILL BE INSERTED HERE]
  }
}

Assume that the project name is project and the project version is 1.0.

To change the base name of the jar file:

archiveBaseName.set("name") // .jar name: name-1.0.jar

To change the entire jar file name, write this instead:

archiveFileName.set("name.jar") // .jar name: name.jar

Use ${project.name} and ${project.version} to insert the project name and version respectively, e.g:

archiveFileName.set("${project.name}-${project.version}.jar") // .jar name: project-1.0.jar

score 3 · Answer 4 · answered Mar 18 '19 at 05:33

Read the doc of gradle,the baseName and archiveName is deprecated,you should use archivesBaseName in project level like this:

project(":web") {
    description = "web"
    archivesBaseName = "your-project-name-" + getVersionCode()

    jar {
        // Will include every single one of your dependencies, project or not
        from {
            configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
        }
    }
}

It works fine for my project. I hope it will be helpful for your project.

TyCy · Answer 5 · 2020-11-11T10:32:50.747

2

For Gradle 6.x

Set the version to empty.

version = ''
project.archivesBaseName - It is the way.

More on their DOC!

edited Nov 11 '20 at 10:32

answered Nov 11 '20 at 10:20

TyCy

19
2

score 2 · Answer 6 · answered Dec 24 '22 at 15:32

For Gradle 5.x, 6.x and 7.x
(tested personally on Gradle 7.6 and verified the documentation of version 5)

In more recent versions of Gradle the results described by the OP are achieved automatically by the default building script if you specify the version property in your module build.gradle file (commonly seen right after your plugin block and before any other blocks).
So it would look something like this:

plugins {
    // your plugins...
}

// This is the string you want to have.
version = '1.0.0'

dependencies {
    // your dependencies
}

version accepts any string, so you can also append pre-release strings like 1.0.0-beta if you need to.

However, one more thing to note is that by default Gradle uses the module name as the base name or your archives and jar files. If your module name matches the name of your library this shouldn't be a problem, but a common scenario it to work with sub-modules where you usually have a lib or core module, and in this case your jar file will end up being named something like lib-1.0.0.jar. To avoid this, you can specify the archivesBaseName property. You can put it right below (or above) your version:

version = '1.0.0'
archivesBaseName = 'abc'

This will correctly generate a abc-1.0.0.jar file.
Note that archivesBaseName uses the plural archives, and it comes from the Project type, and NOT the singular form archive that comes from the jar task.

But, if you need more granularity other than what described above, you will indeed need to use the jar task, similarly to how the OP originally intended to.

score 1 · Answer 7 · answered Jun 28 '23 at 20:04

1

In build.gradle.kts, I was able to customize jar naming as follows:

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

tasks.bootJar {
    archiveFileName.set("application-plain.jar")
}

answered Jun 28 '23 at 20:04

TheJeff

3,665
34
52

score 0 · Answer 8 · answered Jan 19 '23 at 14:30

Add Apk base name in gradle

archivesBaseName = "appname-${new Date().format('dd-MM-yy-HHmm')}"

Gradle file

defaultConfig {
    applicationId "com.example.app"
    minSdk 23
    targetSdk 33
    versionCode 5
    versionName "1.0.0"
    testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    archivesBaseName = "appname-${new Date().format('dd-MM-yy-HHmm')}"
    resValue 'string', "authority", applicationId + ".fileprovider"
}

score -1 · Answer 9 · answered Nov 15 '18 at 16:31

-1

If you want to rename the JAR, source JAR and javadoc JAR with a single setting, while still including the classifier and version, set archiveBaseName at the top level.

answered Nov 15 '18 at 16:31

RMorrisey

7,637
9
53
71

1

also a type here, should be 'archivesBaseName' – Gyowanny Pessatto Queiroz Aug 06 '19 at 11:28
This is how it's listed in the gradle docs. Maybe submit an issue? https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveBaseName – RMorrisey Aug 09 '19 at 21:04
So you never tested it? – Gyowanny Pessatto Queiroz Aug 12 '19 at 10:18

score -1 · Answer 10 · answered Oct 23 '21 at 14:01

-1

<pre><code>
apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'application'


jar {
    archivesBaseName = archivesBaseName + '-' + version
}

</pre></code>

For me I just add above

answered Oct 23 '21 at 14:01

Aung Aung

227
1
2
6

Want to specify jar name and version both in build.gradle

10 Answers10

Linked