web-dev-qa-db-fra.com

Publier une bibliothèque Android Android sur Maven avec aar et source jar

Quelqu'un peut-il me donner un indice sur la façon d'utiliser le plugin gradle maven-publish pour publier un projet/module com.Android.library avec aar et source jar? Je peux le faire avec l'ancien plugin maven - mais je voudrais utiliser le nouveau plugin maven-publish.

45
ligi

Voici un exemple utilisant le nouveau maven-publish brancher.

apply plugin: 'maven-publish'

task sourceJar(type: Jar) {
    from Android.sourceSets.main.Java.srcDirs
    classifier "sources"
}

publishing {
    publications {
        bar(MavenPublication) {
            groupId 'com.foo'
            artifactId 'bar'
            version '0.1'
            artifact(sourceJar)
            artifact("$buildDir/outputs/aar/bar-release.aar")
        }
    }
    repositories {
        maven {
            url "$buildDir/repo"
        }
    }
}

Publier avec ./gradlew clean build publish

64
dskinner

Voici ma solution améliorée, basée sur d'autres réponses.

Gist: https://Gist.github.com/Robyer/a6578e60127418b380ca133a1291f017

Changements par rapport aux autres réponses:

  • classifier modifié - il doit être "sources" (( pas "source")
  • Gère les dépendances

    • Prend également en charge @aar et transitive: false. Dans ce cas, nous définissons l'exclusion dans POM pour ignorer toutes les dépendances transitives de cette dépendance.
    • Prend également en charge les règles d'exclusion personnalisées sur les dépendances, par exemple:

      compile('com.example:something:1.0', {
          exclude group: 'com.exclude.this', module: 'some-module'
      })
      
  • N'a pas besoin de spécifier manuellement le chemin de l'artefact.

Journal des modifications:

  • 27.3.2018 - Ajout du support pour api/ implémentation dépendances dans le nouveau Gradle
  • 23.11.2018 - Renommé bundleRelease en bundleReleaseAar tel qu'il a été changé dans le nouveau Gradle (voir this réponse )
  • 23.11.2018 - Changé getAllDependencies en getDependencies pour corriger les entrées résultantes dupliquées (comme mentionné dans les commentaires sur mon Gist) .
  • 23.04.2019 - Enveloppé dans project.afterEvaluate{...} pour le réparer pour le nouveau Gradle.

apply plugin: 'maven-publish'

task androidJavadocs(type: Javadoc) {
    source = Android.sourceSets.main.Java.srcDirs
    classpath += project.files(Android.getBootClasspath().join(File.pathSeparator))
    Android.libraryVariants.all { variant ->
        if (variant.name == 'release') {
            owner.classpath += variant.javaCompile.classpath
        }
    }
    exclude '**/R.html', '**/R.*.html', '**/index.html'
}

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

task androidSourcesJar(type: Jar) {
    classifier = 'sources'
    from Android.sourceSets.main.Java.srcDirs
}

project.afterEvaluate {
    publishing {
        publications {
            maven(MavenPublication) {
                //groupId 'cz.example'
                //artifactId 'custom-artifact'
                //version = Android.defaultConfig.versionName

                artifact bundleReleaseAar
                artifact androidJavadocsJar
                artifact androidSourcesJar

                pom.withXml {
                    final dependenciesNode = asNode().appendNode('dependencies')

                    ext.addDependency = { Dependency dep, String scope ->
                        if (dep.group == null || dep.version == null || dep.name == null || dep.name == "unspecified")
                            return // ignore invalid dependencies

                        final dependencyNode = dependenciesNode.appendNode('dependency')
                        dependencyNode.appendNode('groupId', dep.group)
                        dependencyNode.appendNode('artifactId', dep.name)
                        dependencyNode.appendNode('version', dep.version)
                        dependencyNode.appendNode('scope', scope)

                        if (!dep.transitive) {
                            // If this dependency is transitive, we should force exclude all its dependencies them from the POM
                            final exclusionNode = dependencyNode.appendNode('exclusions').appendNode('exclusion')
                            exclusionNode.appendNode('groupId', '*')
                            exclusionNode.appendNode('artifactId', '*')
                        } else if (!dep.properties.excludeRules.empty) {
                            // Otherwise add specified exclude rules
                            final exclusionNode = dependencyNode.appendNode('exclusions').appendNode('exclusion')
                            dep.properties.excludeRules.each { ExcludeRule rule ->
                                exclusionNode.appendNode('groupId', rule.group ?: '*')
                                exclusionNode.appendNode('artifactId', rule.module ?: '*')
                            }
                        }
                    }

                    // List all "compile" dependencies (for old Gradle)
                    configurations.compile.getDependencies().each { dep -> addDependency(dep, "compile") }
                    // List all "api" dependencies (for new Gradle) as "compile" dependencies
                    configurations.api.getDependencies().each { dep -> addDependency(dep, "compile") }
                    // List all "implementation" dependencies (for new Gradle) as "runtime" dependencies
                    configurations.implementation.getDependencies().each { dep -> addDependency(dep, "runtime") }
                }
            }
        }
    }
}
36
Robyer

Un petit tweak à dskinners répond avec une génération de dépendance correcte:

apply plugin: 'maven-publish'

task sourceJar(type: Jar) {
    from Android.sourceSets.main.Java.srcDirs
    classifier "source"
}

publishing {
    publications {
        bar(MavenPublication) {
            groupId 'com.foo'
            artifactId 'bar'
            version '0.1'
            artifact(sourceJar)
            artifact("$buildDir/outputs/aar/bar-release.aar")
            pom.withXml {
                def dependenciesNode = asNode().appendNode('dependencies')
                //Iterate over the compile dependencies (we don't want the test ones), adding a <dependency> node for each
                configurations.compile.allDependencies.each {
                    if(it.group != null && (it.name != null || "unspecified".equals(it.name)) && it.version != null)
                    {
                        def dependencyNode = dependenciesNode.appendNode('dependency')
                        dependencyNode.appendNode('groupId', it.group)
                        dependencyNode.appendNode('artifactId', it.name)
                        dependencyNode.appendNode('version', it.version)
                    }
                }
            }
        }
    }
    repositories {
        maven {
            url "$buildDir/repo"
        }
    }
}

Et vous pouvez modifier version et groupId en définissant:

version = '1.0.0'
group = 'foo.bar'
28
joecks

Si vous voulez éviter les codes passe-partout, car le maven-publish le plugin n'écrit pas les dépendances dans pom.xml

Essayez ce plugin: Android-maven-publish

publishing {
    publications {
        mavenAar(MavenPublication) {
            groupId 'com.example'
            artifactId 'mylibrary'
            version '1.0.0'
            from components.Android
        }
    }

    repositories {
        maven {
            url "$buildDir/releases"
        }
    }
}
14
bvarga

Vous pouvez également utiliser le plugin Android maven . Il crée les fichiers .aar, javadoc.jar, sources.jar et .pom et met à jour le fichier maven-metadata.xml après avoir téléchargé les fichiers dans le référentiel maven. J'ai également mis le script sur GitHub .

apply plugin: 'com.Android.library'
apply plugin: 'maven'

//Your Android configuration
Android {
    //...
}

//maven repository info
group = 'com.example'
version = '1.0.0'

ext {
    //Specify your maven repository url here
    repositoryUrl = 'ftp://your.maven.repository.com/maven2'
    //Or you can use 'file:\\\\C:\\Temp' or 'maven-temp' for a local maven repository
}

//Upload Android library to maven with javadoc and Android sources
configurations {
    deployerJars
}

//If you want to deploy to an ftp server
dependencies {
    deployerJars "org.Apache.maven.wagon:wagon-ftp:2.2"
}

// custom tasks for creating source/javadoc jars
task javadoc(type: Javadoc) {
    source = Android.sourceSets.main.Java.srcDirs
    classpath += project.files(Android.getBootClasspath().join(File.pathSeparator))
    destinationDir = file("../javadoc/")
    failOnError false
}

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

//Creating sources with comments
task androidSourcesJar(type: Jar) {
    classifier = 'sources'
    from Android.sourceSets.main.Java.srcDirs
}

//Put the androidSources and javadoc to the artifacts
artifacts {
    archives androidSourcesJar
    archives javadocJar
}

uploadArchives {
    repositories {
        mavenDeployer {
            configuration = configurations.deployerJars
            repository(url: repositoryUrl) {
                //if your repository needs authentication
                authentication(userName: "username", password: "password")
            }
        }
    }
}

Appelez-le avec

./gradlew uploadArchives
3
Philipp Hofmann