Comment construire les sources JAR avec Gradle ?

Question

Je travaille sur un projet open source construit avec Gradle. J'aimerais générer un (projet)-sources.jar que je peux charger dans mon IDE (IntelliJ IDEA) et déboguer le projet. Je sais comment charger le fichier si je peux le générer.

J'ai regardé les tâches Gradle disponibles pour le projet et il n'y en a pas une qui génère un fichier source jar.

Quel est le moyen le plus simple de générer un fichier source jar pour ce projet ?

L'ajout de la source dans le fichier jar qui contient les fichiers de classe compilés serait également une bonne chose.

Answer 1

task sourcesJar(type: Jar, dependsOn: classes) {
    classifier = 'sources'
    from sourceSets.main.allSource
}

task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

artifacts {
    archives sourcesJar
    archives javadocJar
}

Answer 2

Solution à partir de Gradle 6.0

En supposant que vous utilisiez le java / java-library avec Gradle 6.0 ou plus récent, vous pouvez obtenir un plugin sourcesJar à l'aide de la configuration suivante :

java {
    withSourcesJar()
    // and/or analogously use “withJavadocJar()” to get a “javadocJar” task
}

Si vous utilisez en plus l'option maven-publish / ivy-publish (recommandé de nos jours), ce dernier publiera également un fichier *-sources.jar avec votre principale publication Java.

Voir aussi la documentation Gradle .

Answer 3

Si vous utilisez Android :

task sourcesJar(type: Jar) {
    from android.sourceSets.main.java.srcDirs
    classifier = 'sources'
}

task javadoc(type: Javadoc) {
    source = android.sourceSets.main.java.srcDirs
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
}

task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

artifacts {
    archives javadocJar
    archives sourcesJar
}

de aquí

Answer 4

Si vous souhaitez ajouter les sources au fichier JAR des classes compilées ce qui, d'après vous, serait acceptable, vous pouvez le faire assez facilement. Il suffit d'ajouter ce qui suit à votre fichier de compilation. Vous pouvez voir que, en théorie, c'est tout à fait comme la solution pour mettre les sources dans un JAR séparé :

 jar {
     from sourceSets.main.allSource
 }

La différence est que vous l'ajoutez au fichier JAR principal en disant "jar" au lieu de sourcesJar.

Answer 5

Cela devrait fonctionner

assemble.dependsOn 'propertyJar'

task propertyJar(type: Jar) {
 archiveName = "myJarName.jar"
 from('src/main/resources') {
    include '**'
 }}