Libray development: open source your ideas

Have you ever thought that your idea could help other developers? Join the magic world of open source! In this talk we are going to share some tips and the secrets to become an open source master. Of course some practical examples based on our experience cannot miss.
Thanks to Marco Gomiero for collaborating in this presentation.

Transcript

1. Library development: open source your ideas DEVFEST MILANO 2018 6th October 2018
2. MARCO GOMIERO - Computer Engineer (Almost) - Android Engineer @ Uniwhere - Co-Leader @ GDG Venezia WHO WE ARE ANDREA MAGLIE FOLLOW ME: • twitter.com/marcoGomier • github.com/prof18 • marco.gomiero.93@gmail.com • marcogomiero.com - Computer Engineer - Software Engineer @ Musement - Founder @ GDG Venezia FOLLOW ME: • twitter.com/TechIsFun • github.com/TechIsFun • andrea.maglie@gmail.com • andreamaglie.com
3. AGENDA 1. Why ? 2. How to publish code and make it “open” 3. How to check code quality 4. How to publish artifacts 5. How to choose a license
4. DISCLAIMER: all it’s based on our experience
5. How about you?
6. Library? Open source? Why?
7. Contribute and help the community
8. Divide and conquer
9. Gain coding experience
10. Build reputation (also for your CV)
11. How?
12. RSS Parser
13. RSS Parser
14. THE EASY WAY
15. • GITHUB • TRAVIS CI • JITPACK
16. • GITHUB
17. 1. Start a new project from GitHub 2. Push local project to GitHub 3. Fork a project
18. 1. Start a new project from GitHub
19. 1. Start a new project from GitHub
20. > git init > git add . > git commit -m "git setup" > git remote add origin <remote repository URL> > git push -u origin master 2. Push local project to GitHub
21. 3. Fork a project
22. 3. Fork a project
23. 4. Pull Request
24. 4. Pull Request
25. • TRAVIS CI
26. • https://travis-ci.org/ • Free • Easy to configure and manage
27. 1. Login with Github 2. Enable repository
28. 3. travis.yml (1) language: android android: components: - build-tools-27.0.3 - android-27 - add-on - extra script: - "./gradlew build"
29. > gem install travis > travis setup releases 3. travis.yml (2)
30. 3. travis.yml (3) ... deploy: provider: releases api_key: secure: pEgyNmHdAexY2Vtjn file: rssparser/build/outputs/aar/rssparser-release.aar skip_cleanup: true on: repo: TechIsFun/RSS-Parser branch: master tags: true
32. 4. Badge
33. 4. Badge
34. • JITPACK
35. • https://jitpack.io/ • Free for public repos • Works only for Java and Android libraries
36. Jitpack
37. Jitpack
38. Jitpack allprojects { repositories { ... maven { url 'https://jitpack.io' } } }
39. Jitpack dependencies { implementation 'com.github.techisfun:rss-parser:0.1' }
40. Jitpack [] (https://jitpack.io/#techisfun/RSS-Parser)
41. • https://github.com/checkstyle/checkstyle • tool for checking Java source code for adherence to a Code Standard or set of validation rules
42. build.gradle (1) apply plugin: 'checkstyle'
43. task checkstyle(type: Checkstyle) { configFile rootProject.file('checkstyle.xml') source 'src/main/java' ignoreFailures false showViolations true include '**/*.java' classpath = files() } build.gradle (2)
44. afterEvaluate { if (project.tasks.findByName('check')) { check.dependsOn('checkstyle') } } build.gradle (3)
45. ./gradlew rssparser:checkstyle ./gradlew build Checkstyle
46. THE “TRICKIEST” WAY
47. THE “TRICKIEST” WAY OR BETTER ...
48. THE “COOLEST” WAY
49. dependencies { implementation 'com.github.User:Repo:Tag' } The easy way
50. com.github in front of my name?
51. • BINTRAY • JCENTER
52. • https://bintray.com • Free • Publish, Store, Promote, and Distribute Software
53. • JCenter is a Maven repository hosted by Bintray • Default Repository of Android Studio
54. Scenario Build the Library Upload to Bintray Sync to jcenter
55. Create a Bintray account
56. Select Maven
57. Add New Package
58. Add New Package
59. Add New Package
60. Library repo is ready
61. Project: build.gradle dependencies { classpath 'com.android.tools.build:gradle:3.1.4' classpath 'com.github.dcendents:android-maven-gradle-plugin:2.0' classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.8.0' }
62. Library module: publish.gradle (1) apply plugin: 'maven-publish' apply plugin: 'com.jfrog.bintray' version '1.4.4' group 'com.prof.rssparser'
63. Library module: publish.gradle (1) apply plugin: 'maven-publish' apply plugin: 'com.jfrog.bintray' version '1.4.4' group 'com.prof.rssparser'
64. Library module: publish.gradle (1) apply plugin: 'maven-publish' apply plugin: 'com.jfrog.bintray' version '1.4.4' group 'com.prof.rssparser'
65. Library module: publish.gradle (2) publishing { publications { Production(MavenPublication) { artifact("$buildDir/outputs/aar/rssparser-release.aar") { builtBy tasks.getByName("assembleRelease") } groupId artifactId 'rssparser' version this.version pom.withXml { def dependenciesNode = asNode().appendNode('dependencies') // Add the dependecies configurations.implementation.allDependencies.each { // Ensure dependencies such as fileTree are not included in the pom. if (it.name != 'unspecified') { def dependencyNode = dependenciesNode.appendNode('dependency') dependencyNode.appendNode('groupId', it.group) dependencyNode.appendNode('artifactId', it.name) dependencyNode.appendNode('version', it.version) } } } } } }
66. Library module: publish.gradle (2) publishing { publications { Production(MavenPublication) { artifact("$buildDir/outputs/aar/rssparser-release.aar") { builtBy tasks.getByName("assembleRelease") } groupId artifactId 'rssparser' version this.version pom.withXml { def dependenciesNode = asNode().appendNode('dependencies') // Add the dependecies configurations.implementation.allDependencies.each { // Ensure dependencies such as fileTree are not included in the pom. if (it.name != 'unspecified') { def dependencyNode = dependenciesNode.appendNode('dependency') dependencyNode.appendNode('groupId', it.group) dependencyNode.appendNode('artifactId', it.name) dependencyNode.appendNode('version', it.version) } } } } } }
67. Library module: publish.gradle (2) publishing { publications { Production(MavenPublication) { artifact("$buildDir/outputs/aar/rssparser-release.aar") { builtBy tasks.getByName("assembleRelease") } groupId artifactId 'rssparser' version this.version pom.withXml { def dependenciesNode = asNode().appendNode('dependencies') // Add the dependecies configurations.implementation.allDependencies.each { // Ensure dependencies such as fileTree are not included in the pom. if (it.name != 'unspecified') { def dependencyNode = dependenciesNode.appendNode('dependency') dependencyNode.appendNode('groupId', it.group) dependencyNode.appendNode('artifactId', it.name) dependencyNode.appendNode('version', it.version) } } } } } }
68. Library module: publish.gradle (3) bintray { user = properties.getProperty("bintray.user") key = properties.getProperty("bintray.apikey") publications = ['Production'] configurations = ['archives'] override = true pkg { repo = 'maven' name = 'RSS-Parser' description = "An Android library to parse RSS Feed" publicDownloadNumbers = true licenses = ['Apache-2.0'] vcsUrl = 'https://github.com/prof18/RSS-Parser.git' version { name = this.version desc = "Example ${this.version}" released = new Date() vcsTag = this.version } } }
69. Library module: publish.gradle (3) bintray { user = properties.getProperty("bintray.user") key = properties.getProperty("bintray.apikey") publications = ['Production'] configurations = ['archives'] override = true pkg { repo = 'maven' name = 'RSS-Parser' description = "An Android library to parse RSS Feed" publicDownloadNumbers = true licenses = ['Apache-2.0'] vcsUrl = 'https://github.com/prof18/RSS-Parser.git' version { name = this.version desc = "Example ${this.version}" released = new Date() vcsTag = this.version } } }
70. Library module: publish.gradle (3) bintray { user = properties.getProperty("bintray.user") key = properties.getProperty("bintray.apikey") publications = ['Production'] configurations = ['archives'] override = true pkg { repo = 'maven' name = 'RSS-Parser' description = "An Android library to parse RSS Feed" publicDownloadNumbers = true licenses = ['Apache-2.0'] vcsUrl = 'https://github.com/prof18/RSS-Parser.git' version { name = this.version desc = "Example ${this.version}" released = new Date() vcsTag = this.version } } }
71. bit.ly/publishgradle CODE ON:
72. apply plugin: 'com.android.library' android { compileSdkVersion 28 ... } dependencies { ... } apply from: 'publish.gradle' Library module: build.gradle
73. apply plugin: 'com.android.library' android { compileSdkVersion 28 ... } dependencies { ... } apply from: 'publish.gradle' Library module: build.gradle
74. Compile the library ./gradlew clean build bintrayUpload --info
75. Publish the new version
76. Publish the new version
77. Add the library to jcenter
78. Add the library to jcenter
79. Request the publication on jcenter
80. The library finally is on jcenter!
81. The library finally is on jcenter!
82. dependencies { implementation 'com.prof.rssparser:rssparser:1.4.4' } Use the library
83. License?
84. MIT License “do anything you want with my code”
85. Apache License 2.0 “do anything you want” + “keep copyright”
86. GNU GPLv3 “do anything you want” + “keep copyright” + “keep GNU GPLv3 license”
87. Contributing? You don’t need to choose a license!
88. Help? https://choosealicense.com/
89. Q & A
90. DevFest Veneto 2018 It’s coming!! 24 Novembre @ Fabrica - Catena di Villorba - TV Call For Paper opening soon!
91. Android Developers Italia Android Developers Italia é la community italiana di sviluppatori Android su Slack! androiddevs.it
92. THANK YOU