Automated library distribution to Maven

Transcript

AUTOMATED LIBRARY DISTRIBUTION TO MAVEN
@MOLSJEROEN

BEFORE SOFTWARE CAN BE REUSABLE
IT FIRST HAS TO BE USABLE.
Ralph Johnson

MAVEN FUNDAMENTALS

@MOLSJEROEN
WHAT IS MAVEN
▸ Build automation tool
1. Describes how software is built
‣ default conventions
‣ specify all exceptions
2. Describes dependencies
‣ locally installed repository
‣ remote Maven repository

View Slide

@MOLSJEROEN
HOW MAVEN HANDLES DEPENDENCIES
▸ Release identiﬁed by
▸ GroupId com.jeroenmols
▸ ArtifactId landscapevideocamera
▸ Version 1.1.3
▸ Multiple artifacts possible
▸ Library landscapevideocamera.aar
▸ Documentation javadoc.jar
▸ Sources sources.jar

View Slide

@MOLSJEROEN
HOW MAVEN STORES DEPENDENCIES

View Slide

@MOLSJEROEN
IMPORTANT CONSIDERATIONS
▸ Maven can only be used if:
▸ Repository reachable and online forever
▸ Existing artifacts never modiﬁed
▸ New versions come from same developer
▸ Code must always build immediately after checkout
▸ When doubt: add artifacts to version control

View Slide

@MOLSJEROEN
ADOPTION BY ANDROID
▸ Gradle
▸ Specify Maven repositories to use
▸ Deﬁne dependencies (and conﬁguration)
▸ Upload your own artifacts
▸ Local maven repository
▸ Support libraries
▸ Google play services

View Slide

@MOLSJEROEN
GRADLE - USE MAVEN ARTIFACTS
allprojects { 
repositories { 
jcenter() 
maven { url “http://mywebsite.com/mavenrepository" } 
} 
}
dependencies { 
compile fileTree(dir: 'libs', include: ['*.jar']) 
compile ‘com.android.support:appcompat-v7:23.1.0’
 
compile ‘com.jeroenmols:landscapevideocamera:1.1.3' 
}

View Slide

@MOLSJEROEN
allprojects { 
repositories { 
jcenter() 
} 
}
dependencies { 
 
}

View Slide

@MOLSJEROEN
allprojects { 
repositories { 
jcenter() 
} 
}
dependencies { 
 
}

View Slide

@MOLSJEROEN
allprojects { 
repositories { 
jcenter() 
} 
}
dependencies { 
 
compile ‘com.jeroenmols:landscapevideocamera:1.1.3’ 
}
GroupId ArtifactId Version

View Slide

@MOLSJEROEN
GRADLE - UPLOAD MAVEN ARTIFACTS
apply plugin: ‘maven'
uploadArchives { 
repositories { 
mavenDeployer { 
repository(url: 'http://mywebsite/mavenrepository') { 
authentication(userName: 'myUsername',
password: 'myPassword') 
} 
 
pom.project { 
groupId = ‘packageName’
artifactId = 'libraryName' 
version = 'libraryVersion' 
packaging = 'aar' 
} } } }

View Slide

@MOLSJEROEN
uploadArchives { 
repositories { 
mavenDeployer { 
} 
 
pom.project { 
} } } }

View Slide

@MOLSJEROEN
uploadArchives { 
repositories { 
mavenDeployer { 
} 
 
pom.project { 
} } } }

View Slide

@MOLSJEROEN
uploadArchives { 
repositories { 
mavenDeployer { 
} 
 
pom.project { 
} } } }

View Slide

THERE IS AN EASY WAY AND A HARD
WAY. THE HARD PART IS FINDING THE
EASY WAY.
Dr. Lloyd

View Slide

PUBLIC DISTRIBUTION

View Slide

@MOLSJEROEN
PUBLIC MAVEN REPOSITORIES
repositories { 
jcenter() 
}
‣ Bintray
‣ Browse repository
repositories { 
mavenCentral() 
}
‣ Sonatype

View Slide

@MOLSJEROEN
PUBLIC MAVEN REPOSITORIES
repositories { 
jcenter() 
}
‣ Bintray
repositories { 
mavenCentral() 
}
‣ Sonatype

View Slide

@MOLSJEROEN
BINTRAY
▸ Attractive convenient UI
▸ Simple to use (no signing)
▸ Integrates with Github, Bitbucket, Twitter,…
▸ Download statistics
▸ Gradle/manual upload to staging
▸ Manually release to JCenter
▸ One click/automated sync to Maven Central

View Slide

@MOLSJEROEN

View Slide

@MOLSJEROEN

View Slide

@MOLSJEROEN
BINTRAY - UPLOAD ARTIFACTS 1
‣ PROJECT_HOME/local.properties
bintray.user=jeroenmols 
bintray.apikey=n1c3try
‣ PROJECT_HOME/build.gradle
buildscript { 
dependencies { 
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.2' 
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3' 
} 
}

View Slide

@MOLSJEROEN
buildscript { 
dependencies { 
} 
}

View Slide

@MOLSJEROEN
buildscript { 
dependencies { 
} 
}

View Slide

@MOLSJEROEN
‣ LIBRARY_HOME/build.gradle
ext { 
bintrayRepo = 'maven' 
bintrayName = 'LandscapeVideoCamera' 
 
publishedGroupId = 'com.github.jeroenmols' 
libraryName = 'LandscapeVideoCamera' 
artifact = 'library' 
 
libraryDescription = 'Powerful custom Android Camera.’
libraryVersion = '1.1.4' 
 
developerId = 'JeroenMols' 
developerName = 'Jeroen Mols' 
developerEmail = '[email protected]' 
}
apply from: 'https://raw.githubusercontent.com/attwellBrian/JCenter/master/installv1.gradle' 
apply from: 'https://raw.githubusercontent.com/attwellBrian/JCenter/master/bintrayv1.gradle'

View Slide

@MOLSJEROEN
ext { 
 
 
 
}

View Slide

@MOLSJEROEN
ext { 
 
 
 
}

View Slide

@MOLSJEROEN
ext { 
 
 
 
}

View Slide

@MOLSJEROEN
‣ $ ./gradlew assembleRelease bintrayUpload

View Slide

@MOLSJEROEN

View Slide

@MOLSJEROEN
JITPACK.IO
▸ Zero conﬁguration: no account, no set up, no opt-in
▸ Download statistics, Badges,…
▸ Supports snapshots
▸ No need to upload artifacts
▸ Builds any GitHub project (and more)
▸ Use Git tags to create a ‘formal’ release (optional)
▸ Gradle dependency on Jitpack repository

View Slide

@MOLSJEROEN
JITPACK.IO - UPLOAD ARTIFACTS
DO NOTHING

View Slide

@MOLSJEROEN
JITPACK.IO - CONSUME ARTIFACTS
allprojects { 
repositories { 
jcenter() 
maven { url "https://jitpack.io" } 
} }
‣ MODULE_HOME/build.gradle
dependencies { 
compile 'com.github.JeroenMols:LandscapeVideoCamera:1.1.1' 
}

View Slide

@MOLSJEROEN
allprojects { 
repositories { 
jcenter() 
} }
dependencies { 
}

View Slide

@MOLSJEROEN
allprojects { 
repositories { 
jcenter() 
} }
dependencies { 
}

View Slide

@MOLSJEROEN
allprojects { 
repositories { 
jcenter() 
} }
dependencies { 
compile ‘com.github.JeroenMols:LandscapeVideoCamera:
3f900ec00b302f75f3d377cff0bdca37145fc89d' 
}

View Slide

@MOLSJEROEN
allprojects { 
repositories { 
jcenter() 
} }
dependencies { 
compile ‘com.github.JeroenMols:LandscapeVideoCamera:
develop-SNAPSHOT‘ 
}

View Slide

I THINK, FUNDAMENTALLY, OPEN
SOURCE DOES TEND TO BE MORE
STABLE SOFTWARE.
Linus Torvalds

View Slide

PRIVATE DISTRIBUTION

View Slide

@MOLSJEROEN
▸ Easy to set up Maven repository
▸ Cache remote repository artifacts
▸ Open source (free)
▸ Gradle plugin to do the upload
▸ Advanced features
▸ Backups?
▸ Cost/hassle of running a server?
REPOSITORY MANAGER - ARTIFACTORY
RELATED BLOGPOSTS

View Slide

@MOLSJEROEN

View Slide

@MOLSJEROEN
ARTIFACTORY - UPLOAD ARTIFACTS 1
buildscript { 
dependencies {
classpath “org.jfrog.buildinfo:
build-info-extractor-gradle:3.1.1" 
} 
}

View Slide

@MOLSJEROEN
buildscript { 
dependencies {
classpath “org.jfrog.buildinfo:
build-info-extractor-gradle:3.1.1" 
} 
}

View Slide

@MOLSJEROEN
apply plugin: 'maven-publish'
def packageName = 'com.jeroenmols.awesomelibrary' 
def libraryVersion = '1.0.0'
publishing { 
publications { 
aar(MavenPublication) { 
groupId = packageName 
version = libraryVersion 
artifactId = project.getName() 
artifact("$buildDir/outputs/aar/${project.getName()}-release.aar") 
} } }

View Slide

@MOLSJEROEN
publishing { 
publications { 
} } }

View Slide

@MOLSJEROEN
publishing { 
publications { 
} } }

View Slide

@MOLSJEROEN
publishing { 
publications { 
} } }

View Slide

@MOLSJEROEN
publishing { 
publications { 
} } }

View Slide

@MOLSJEROEN
apply plugin: ‘com.jfrog.artifactory'
artifactory { 
contextUrl = 'http://localhost:8081/artifactory' 
publish { 
repository { 
repoKey = 'libs-release-local' 
username = "admin" 
password = "password" 
} 
defaults { 
publications('aar') 
publishArtifacts = true 
publishPom = true 
} 
} }

View Slide

@MOLSJEROEN
artifactory { 
publish { 
repository { 
} 
defaults { 
} 
} }

View Slide

@MOLSJEROEN
artifactory { 
publish { 
repository { 
} 
defaults { 
} 
} }

View Slide

@MOLSJEROEN
artifactory { 
publish { 
repository { 
} 
defaults { 
} 
} }

View Slide

@MOLSJEROEN
artifactory { 
publish { 
repository { 
} 
defaults { 
} 
} }

View Slide

@MOLSJEROEN
▸ $ gradle assembleRelease artifactoryPublish

View Slide

@MOLSJEROEN
ARTIFACTORY - CONSUME ARTIFACTS
allprojects { 
repositories { 
maven {
url “http://localhost:8081/artifactory/libs-release-local"
} } }
dependencies { 
compile 'com.jeroenmols.awesomelibrary:1.0.0' 
}

View Slide

@MOLSJEROEN
allprojects { 
repositories { 
maven {
} } }
dependencies { 
}

View Slide

@MOLSJEROEN
allprojects { 
repositories { 
maven {
} } }
dependencies { 
}

View Slide

@MOLSJEROEN
WAGON-GIT
▸ Use a Git as a Maven repository
▸ Supports GitHub and BitBucket (public or private)
▸ Open source (free)
▸ Maven plugin to do the upload
▸ Inherent backups and remote access
RELATED BLOGPOST

View Slide

@MOLSJEROEN

View Slide

@MOLSJEROEN

View Slide

@MOLSJEROEN
WAGON-GIT - UPLOAD ARTIFACTS 1
▸ LIBRARY_HOME/gradle.properties
ARTIFACT_VERSION=1.0.0 
ARTIFACT_NAME=landscapevideocamera 
ARTIFACT_PACKAGE=com.jeroenmols.landscapevideocamera
ARTIFACT_PACKAGING=aar 
 
BITBUCKET_TEAM=jmolsmobile 
REPOSITORY_NAME=maven_repository
▸ PROJECT_HOME/gradle.properties
USERNAME= 
PASSWORD=

View Slide

@MOLSJEROEN
 
USERNAME= 
PASSWORD=

View Slide

@MOLSJEROEN
 
USERNAME= 
PASSWORD=

View Slide

@MOLSJEROEN
 
USERNAME= 
PASSWORD=

View Slide

@MOLSJEROEN
▸ LIBRARY_HOME/build.gradle
apply from: 'https://raw.githubusercontent.com/JeroenMols/
GitAsMaven/master/publish-bitbucket.gradle'
▸ $ gradle assembleRelease uploadArchives

View Slide

@MOLSJEROEN
CONSUME ARTIFACTS
allprojects { 
repositories { 
maven { 
credentials { 
username '' 
password ‘' 
} 
url "https://api.bitbucket.org/1.0/repositories/"
+ “//raw/releases" 
} } }
dependencies { 
compile "com.jeroenmols:landscapevideocamera:" 
}

View Slide

@MOLSJEROEN
CONSUME ARTIFACTS
allprojects { 
repositories { 
maven { 
credentials { 
username '' 
password ‘' 
} 
} } }
dependencies { 
compile “com.jeroenmols:landscapevideocamera:" 
}

View Slide

@MOLSJEROEN
CONSUME ARTIFACTS
allprojects { 
repositories { 
maven { 
credentials { 
username '' 
password ‘' 
} 
} } }
dependencies { 
compile “com.jeroenmols:landscapevideocamera:" 
}

View Slide

@MOLSJEROEN
CONSUME ARTIFACTS
allprojects { 
repositories { 
maven { 
credentials { 
username '' 
password ‘' 
} 
} } }
dependencies { 
compile "com.jeroenmols:landscapevideocamera:" 
}

View Slide

@MOLSJEROEN
PUBLISH-BITBUCKET SCRIPT
▸ Dramatically simpliﬁes conﬁguration
▸ Check for existing artifacts
▸ Bitbucket authentication

View Slide

@MOLSJEROEN
PUBLISH-BITBUCKET SCRIPT - SIMPLIFY CONFIGURATION 1
▸ PROJECT_HOME/build.gradle
apply plugin: 'maven'
 
uploadArchives { 
repositories.mavenDeployer { 
configuration = configurations.deployLibrary
 
repository(url: 'git:releases://[email protected]:'
+ COMPANY + '/' + REPOSITORY_NAME + '.git ') 
 
pom.project { 
groupId = ARTIFACT_PACKAGE 
version = ARTIFACT_VERSION 
artifactId = ARTIFACT_NAME 
packaging = ARTIFACT_PACKAGING 
} } }

View Slide

@MOLSJEROEN
 
uploadArchives { 
 
 
pom.project { 
} } }

View Slide

@MOLSJEROEN
 
uploadArchives { 
 
 
pom.project { 
} } }

View Slide

@MOLSJEROEN
 
uploadArchives { 
 
 
pom.project { 
} } }

View Slide

@MOLSJEROEN
task androidJavadocs(type: Javadoc) { 
failOnError false 
source = android.sourceSets.main.java.sourceFiles 
} 
 
task androidSourcesJar(type: Jar) { 
classifier = 'sources' 
from android.sourceSets.main.java.sourceFiles 
} 
 
task androidJavadocsJar(type: Jar, dependsOn: androidJavadocs) { 
classifier = 'javadoc' 
from androidJavadocs.destinationDir 
} 
 
artifacts { 
archives androidSourcesJar 
archives androidJavadocsJar 
}

View Slide

@MOLSJEROEN
task androidJavadocs(type: Javadoc) { 
failOnError false 
source = android.sourceSets.main.java.sourceFiles 
} 
 
task androidSourcesJar(type: Jar) { 
classifier = 'sources' 
from android.sourceSets.main.java.sourceFiles 
} 
 
task androidJavadocsJar(type: Jar, dependsOn: androidJavadocs) { 
classifier = 'javadoc' 
from androidJavadocs.destinationDir 
} 
 
artifacts { 
archives androidSourcesJar 
archives androidJavadocsJar 
}

View Slide

@MOLSJEROEN
repositories { 
maven {
url "https://raw.github.com/synergian/wagon-git/releases"
} } 
 
configurations { 
deployLibrary 
} 
 
dependencies { 
deployLibrary "ar.com.synergian:wagon-git:0.2.0" 
}

View Slide

@MOLSJEROEN
repositories { 
maven {
} } 
 
configurations { 
deployLibrary 
} 
 
dependencies { 
}

View Slide

@MOLSJEROEN
repositories { 
maven {
} } 
 
configurations { 
deployLibrary 
} 
 
dependencies { 
}

View Slide

@MOLSJEROEN
PUBLISH-BITBUCKET SCRIPT - EXISTING ARTIFACTS 1
uploadArchives.dependsOn lookForArtifacts
task lookForArtifacts { 
doLast { 
def libraryName = ARTIFACT_NAME + '-' + ARTIFACT_VERSION + '.aar' 
def repoPath = ARTIFACT_PACKAGE.replace(".", "/") + "/"
+ ARTIFACT_NAME + "/" + ARTIFACT_VERSION + "/" + libraryName 
def repositoryUrl = 'https://api.bitbucket.org/1.0/repositories/'
+ COMPANY + '/' + REPOSITORY_NAME + '/raw/releases/' + repoPath 
if (urlExists(repositoryUrl)) { 
throw new RuntimeException(“Artifact exists:" + ARTIFACT_VERSION) 
} 
return true 
} }

View Slide

@MOLSJEROEN
doLast { 
} 
return true 
} }

View Slide

@MOLSJEROEN
doLast { 
} 
return true 
} }

View Slide

@MOLSJEROEN
doLast { 
} 
return true 
} }

View Slide

@MOLSJEROEN
doLast { 
} 
return true 
} }

View Slide

@MOLSJEROEN
def urlExists(String repositoryUrl) { 
try { 
def conn = (HttpURLConnection) new URL(repositoryUrl).openConnection() 
 
conn.setRequestProperty("Authorization","Basic " +
getBase64EncodedCredentials()) 
conn.setConnectTimeout(10000) 
conn.setReadTimeout(10000) 
conn.setRequestMethod("HEAD") 
 
def responseCode = connection.getResponseCode() 
println("responseCode: " + responseCode) 
 
return (200 == responseCode)
 
} catch (IOException ignored) { 
return false 
} }

View Slide

@MOLSJEROEN
try { 
 
 
 
 
return false 
} }

View Slide

@MOLSJEROEN
try { 
 
 
 
 
return false 
} }

View Slide

@MOLSJEROEN
PUBLISH-BITBUCKET SCRIPT - BITBUCKET AUTHENTICATION
def getBase64EncodedCredentials() { 
def s = USERNAME + ":" + PASSWORD; 
return s.bytes.encodeBase64().toString() 
}

View Slide

@MOLSJEROEN
CREDITS
▸ Distributing Android Libraries via jCenter for Gradle Importing @attwellbrian
▸ A private Maven repository in 30 min @molsjeroen
▸ Getting the most out of Artifactory @molsjeroen
▸ Git as a secure private Maven repository @molsjeroen

View Slide

@MOLSJEROEN
GITHUB SAMPLES
▸ Bintray example @attwellbrian
▸ Artifactory example @molsjeroen
▸ Wagon-git example @molsjeroen

View Slide

@MOLSJEROEN
OTHER INTERESTING ARTICLES
▸ Gradle dependency and local repository @turhanoz
▸ Creating and publishing an Android library @Etienne_Lawlor
▸ Publish with Gradle on BitBucket @mul0w
▸ Gradle Maven Push script @chrisbanes

View Slide

@MOLSJEROEN
MANY THANKS
▸ Jeroen Mols (Belgium)
▸ @MolsJeroen
▸ http://jeroenmols.com

View Slide

Automated library distribution to Maven

Automated library distribution to Maven

Jeroen Mols

More Decks by Jeroen Mols

Other Decks in Programming

Featured

Transcript