Jak zbudować słoik ze źródłami za pomocą gradle

Pracuję z projektem open source, który jest zbudowany z Gradle. Chciałbym wygenerować plik (projekt) -sources.jar, który mogę załadować do mojego IDE (IntelliJ IDEA) i debugować za pośrednictwem projektu. Wiem, jak załadować plik, jeśli mogę go wygenerować.

Przejrzałem dostępne zadania gradle dla projektu i nie ma takiego, który generuje plik jar źródeł.

Jaki jest najłatwiejszy sposób wygenerowania źródłowego pliku jar dla tego projektu?

Dodanie źródła do pliku jar, który zawiera skompilowane pliki klas, również byłoby w porządku.

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
}

Jeśli używasz Androida:

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
}

od tutaj

Jeśli chcesz dodać źródła do skompilowanego pliku JAR klas , co również powiedziałeś, że byłoby do przyjęcia, możesz to zrobić dość łatwo. Po prostu dodaj następujące elementy do pliku kompilacji. Możesz zobaczyć, że w teorii jest to całkiem podobne do rozwiązania polegającego na umieszczeniu źródeł w oddzielnym JAR:

 jar {
     from sourceSets.main.allSource
 }

Różnica polega na tym, że dodajesz go do głównego pliku JAR, mówiąc „jar” zamiast sourcesJar.

Rozwiązanie od Gradle 6.0

Zakładając, że używasz wtyczki java/ java-libraryz Gradle 6.0 lub nowszym, możesz uzyskać sourcesJarzadanie przy użyciu następującej konfiguracji:

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

Jeśli dodatkowo użyjesz wtyczki maven-publish/ ivy-publish(obecnie zalecanej), spowoduje to również opublikowanie *-sources.jarartefaktu wraz z główną publikacją Java.

Zobacz także dokumentację Gradle .

to powinno działać

assemble.dependsOn 'propertyJar'

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

Odpowiednik Kotlin DSL wyglądałby następująco:

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)
    }
}

Podczas używania:

• Gradle: 5+
• javai maven-publishwtyczki

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