Wie man Quellenglas mit Gradle baut

Ich arbeite mit einem Open-Source-Projekt, das mit gradle erstellt wurde. Ich möchte eine (Projekt-) -sources.jar-Datei generieren, die ich in meine IDE (IntelliJ IDEA) laden und über das Projekt debuggen kann. Ich kann die Datei laden, wenn ich sie generieren kann.

Ich habe die verfügbaren Gradle-Aufgaben für das Projekt durchgesehen und es gibt keine, die eine Quell-JAR-Datei generiert.

Was ist der einfachste Weg, um eine Quell-JAR-Datei für dieses Projekt zu generieren?

Das Hinzufügen der Quelle zu der JAR-Datei, die die kompilierten Klassendateien enthält, ist ebenfalls in Ordnung.

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
}

Wenn Sie Android verwenden:

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
}

von hier

Wenn Sie die Quellen zur JAR-Datei für kompilierte Klassen hinzufügen möchten , von der Sie auch sagten, dass sie akzeptabel wäre, können Sie dies problemlos tun. Fügen Sie Ihrer Build-Datei einfach Folgendes hinzu. Sie können sehen, dass es theoretisch der Lösung ähnelt, Quellen in ein separates JAR zu stellen:

 jar {
     from sourceSets.main.allSource
 }

Der Unterschied besteht darin, dass Sie es zur Haupt-JAR-Datei hinzufügen, indem Sie "jar" anstelle von sourceJar sagen.

Lösung ab Gradle 6.0

Angenommen, Sie verwenden das Plugin java/ java-librarymit Gradle 6.0 oder höher, können Sie eine sourcesJarAufgabe mit der folgenden Konfiguration erhalten:

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

Wenn Sie zusätzlich das Plugin maven-publish/ verwenden ivy-publish(heutzutage empfohlen), wird dadurch auch ein *-sources.jarArtefakt zusammen mit Ihrer Haupt-Java-Publikation veröffentlicht.

Siehe auch die Gradle-Dokumente .

das sollte funktionieren

assemble.dependsOn 'propertyJar'

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

Das Kotlin DSL-Äquivalent wäre:

tasks {

    val sourcesJar by creating(Jar::class) {
        dependsOn(JavaPlugin.CLASSES_TASK_NAME)
        classifier = "sources"
        from(java.sourceSets["main"].allSource)
    }

    val javadocJar by creating(Jar::class) {
        dependsOn(JavaPlugin.JAVADOC_TASK_NAME)
        classifier = "javadoc"
        from(java.docsDir)
    }

    artifacts {
        add("archives", sourcesJar)
        add("archives", javadocJar)
    }
}

Beim Benutzen:

• Gradle: 5+
• javaund maven-publishPlugins

task sourceJar(type: Jar) {
    from sourceSets.main.allJava
    archiveClassifier = "sources"
}

publishing {
    publications {
        maven(MavenPublication) {
            from components.java
            artifact sourceJar
        }
    }
}

https://docs.gradle.org/current/dsl/org.gradle.api.publish.maven.MavenPublication.html