├── LICENSE
└── README.md
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
203 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | **Publish an aar file to jCenter with Gradle:**
2 | ----------------------------------------------------------------------
3 | Firstly I thank [JBaruch](http://stackoverflow.com/users/402053/jbaruch), who patiently drove me all along the process of publishing (see the [stackoverflow question](http://stackoverflow.com/questions/28383415/publish-an-aar-file-to-maven-central-with-gradle-not-working)).
4 | Now I'm going to list how to publish an Android libray to jCenter and then syncronize it with Maven Central:
5 |
6 |
7 | 1. I use "Android Studio" and I have this simple android lib that I would like to be available on maven: [Android-Update-Checker](https://github.com/danielemaddaluno/Android-Update-Checker)
8 |
9 | 2. In the library folder(module) I have the lib code abovementioned. And applying in the build.gradle of this folder `apply plugin: 'com.android.library'` i got as output an .aar in the build/outputs/aar/ directory of the module's directory
10 |
11 | 3. Register to [Sonatype](https://issues.sonatype.org/secure/Dashboard.jspa), i registered with username `danielemaddaluno`
12 |
13 | 4. In the [Sonatype OSS Repository](https://issues.sonatype.org/secure/Dashboard.jspa) I registered a project opening a new Issue:
14 | `Create → Create Issue → Community Support - Open Source Project Repository Hosting → New Project → with groupid com.github.danielemaddaluno`
15 | Remember that "only one JIRA issue per top-level groupId is necessary. You have all the necessary permissions to deploy any new artifacts to this groupId or any sub-groups".
16 |
17 | 5. Register to Bintray with a `username`, the one used by me is: `danielemaddaluno`
18 |
19 | 6. Enable the automatically signing of the uploaded content:
20 | from Bintray [profile url](https://bintray.com/profile/edit) → GPG Signing → copy paste your gpg armored `public` and `private` keys.
21 | You can find respectively these two keys in files `public_key_sender.asc` and `private_key_sender.asc`
22 | if you execute the following code (the `-a` or `--armor` option in `gpg`is used to generate ASCII-armored key pair):
23 | ``` bash
24 | gpg --gen-key # generates the key pair
25 | gpg --list-keys # get your PubKeyId (this value is used in the line below)
26 | gpg --keyserver hkp://pool.sks-keyservers.net --send-keys PubKeyId # publish your Key
27 | gpg -a --export daniele.maddaluno@gmail.com > public_key_sender.asc
28 | gpg -a --export-secret-key daniele.maddaluno@gmail.com > private_key_sender.asc
29 | ```
30 |
31 | 7. In the same [web page](https://bintray.com/profile/edit) you can configure the auto-signing from:
32 | `Repositories → Maven → Check the "GPG Sign uploaded files automatically" → Update`
33 |
34 | 8. In the same [web page](https://bintray.com/profile/edit) you can find your `Bintray API Key` (simply copy it for a later use)
35 |
36 | 9. In the same [web page](https://bintray.com/profile/edit) you can configure your `Sonatype OSS User` (created at previous step 3) from the `Account` link
37 |
38 | 10. Add these two lines to the `build.gradle` in the root of your project
39 | ``` gradle
40 | classpath 'com.github.dcendents:android-maven-plugin:1.2'
41 | classpath "com.jfrog.bintray.gradle:gradle-bintray-plugin:1.1"
42 | ```
43 | So that your `build.gradle` in the root looks like this:
44 | ``` gradle
45 | buildscript {
46 | repositories {
47 | jcenter()
48 | }
49 | dependencies {
50 | classpath 'com.android.tools.build:gradle:1.0.0'
51 | classpath 'com.github.dcendents:android-maven-plugin:1.2'
52 | classpath "com.jfrog.bintray.gradle:gradle-bintray-plugin:1.1"
53 | }
54 | }
55 |
56 | allprojects {
57 | repositories {
58 | jcenter()
59 | }
60 | }
61 | ```
62 | 11. Modify the `build.gradle` located inside the library folder.
63 | I modified mine from this:
64 | ``` gradle
65 | apply plugin: 'com.android.library'
66 |
67 | android {
68 | compileSdkVersion 21
69 | buildToolsVersion "21.0.0"
70 |
71 | defaultConfig {
72 | //applicationId "com.madx.updatechecker.lib"
73 | minSdkVersion 8
74 | targetSdkVersion 21
75 | versionCode 1
76 | versionName "1.0.0"
77 | }
78 | buildTypes {
79 | release {
80 | minifyEnabled false
81 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
82 | }
83 | }
84 | }
85 |
86 | dependencies {
87 | compile fileTree(dir: 'libs', include: ['*.jar'])
88 | compile 'org.jsoup:jsoup:+'
89 | }
90 | ```
91 | To this one:
92 |
93 |
94 | ``` gradle
95 | apply plugin: 'com.android.library'
96 | apply plugin: 'com.github.dcendents.android-maven'
97 | apply plugin: "com.jfrog.bintray"
98 |
99 | // This is the library version used when deploying the artifact
100 | version = "1.0.0"
101 |
102 | android {
103 | compileSdkVersion 21
104 | buildToolsVersion "21.1.2"
105 |
106 | defaultConfig {
107 | //applicationId "com.madx.updatechecker.lib"
108 | minSdkVersion 8
109 | targetSdkVersion 21
110 | versionCode 1
111 | versionName "1.0.0"
112 | }
113 | buildTypes {
114 | release {
115 | minifyEnabled false
116 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
117 | }
118 | }
119 | }
120 |
121 | dependencies {
122 | compile fileTree(dir: 'libs', include: ['*.jar'])
123 | compile 'org.jsoup:jsoup:1.8.1'
124 | }
125 |
126 |
127 | def siteUrl = 'https://github.com/danielemaddaluno/Android-Update-Checker' // Homepage URL of the library
128 | def gitUrl = 'https://github.com/danielemaddaluno/Android-Update-Checker.git' // Git repository URL
129 | group = "com.github.danielemaddaluno.androidupdatechecker" // Maven Group ID for the artifact
130 |
131 |
132 | install {
133 | repositories.mavenInstaller {
134 | // This generates POM.xml with proper parameters
135 | pom {
136 | project {
137 | packaging 'aar'
138 |
139 | // Add your description here
140 | name 'Android Update Checker'
141 | description = 'The project aims to provide a reusable instrument to check asynchronously if exists any newer released update of your Android app on the Store.'
142 | url siteUrl
143 |
144 | // Set your license
145 | licenses {
146 | license {
147 | name 'The Apache Software License, Version 2.0'
148 | url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
149 | }
150 | }
151 | developers {
152 | developer {
153 | id 'danielemaddaluno'
154 | name 'Daniele Maddaluno'
155 | email 'daniele.maddaluno@gmail.com'
156 | }
157 | }
158 | scm {
159 | connection gitUrl
160 | developerConnection gitUrl
161 | url siteUrl
162 |
163 | }
164 | }
165 | }
166 | }
167 | }
168 |
169 | task sourcesJar(type: Jar) {
170 | from android.sourceSets.main.java.srcDirs
171 | classifier = 'sources'
172 | }
173 |
174 | task javadoc(type: Javadoc) {
175 | source = android.sourceSets.main.java.srcDirs
176 | classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
177 | }
178 |
179 | task javadocJar(type: Jar, dependsOn: javadoc) {
180 | classifier = 'javadoc'
181 | from javadoc.destinationDir
182 | }
183 | artifacts {
184 | archives javadocJar
185 | archives sourcesJar
186 | }
187 |
188 | Properties properties = new Properties()
189 | properties.load(project.rootProject.file('local.properties').newDataInputStream())
190 |
191 | // https://github.com/bintray/gradle-bintray-plugin
192 | bintray {
193 | user = properties.getProperty("bintray.user")
194 | key = properties.getProperty("bintray.apikey")
195 |
196 | configurations = ['archives']
197 | pkg {
198 | repo = "maven"
199 | // it is the name that appears in bintray when logged
200 | name = "androidupdatechecker"
201 | websiteUrl = siteUrl
202 | vcsUrl = gitUrl
203 | licenses = ["Apache-2.0"]
204 | publish = true
205 | version {
206 | gpg {
207 | sign = true //Determines whether to GPG sign the files. The default is false
208 | passphrase = properties.getProperty("bintray.gpg.password") //Optional. The passphrase for GPG signing'
209 | }
210 | // mavenCentralSync {
211 | // sync = true //Optional (true by default). Determines whether to sync the version to Maven Central.
212 | // user = properties.getProperty("bintray.oss.user") //OSS user token
213 | // password = properties.getProperty("bintray.oss.password") //OSS user password
214 | // close = '1' //Optional property. By default the staging repository is closed and artifacts are released to Maven Central. You can optionally turn this behaviour off (by puting 0 as value) and release the version manually.
215 | // }
216 | }
217 | }
218 | }
219 | ```
220 |
221 | 12. Add to the `local.properties` in the root of the project the following lines (remember that this file should never be uploaded on your public repository):
222 | ``` gradle
223 | bintray.user=
224 | bintray.apikey=
225 |
226 | bintray.gpg.password=
227 | bintray.oss.user=
228 | bintray.oss.password=
229 | ```
230 |
231 | 13. Add to the PATH the default gradle 2.2.1 actually used by "Android Studio", for example:
232 | ``` bash
233 | sudo gedit .bashrc
234 | ```
235 | Add to the bottom of file `.bashrc` the following line (verify your gradle path):
`PATH=$PATH:/etc/android-studio/gradle/gradle-2.2.1/bin`
236 |
237 | 14. Open "Android Studio" terminal and execute:
238 | ``` bash
239 | gradle bintrayUpload
240 | ```
241 |
242 | 15. From [Bintray](https://bintray.com/) → My Recent Packages → androidupdatechecker (this is here only after the execution of the previous point 14 ) → Add to Jcenter → Check the box → Group Id = "com.github.danielemaddaluno.androidupdatechecker".
243 | This will request a review and public listing of your library on jCenter repository.
244 |
245 | 16. Finally Sync all with Maven Central following: Bintray → My Recent Packages → androidupdatechecker → Maven Central → Sync.
246 |
247 | 17. Now your library should be automatically imported both from Maven Central and from Bintray, you can import with something like this:
248 | **Automatically with Gradle**
249 | ``` gradle
250 | dependencies {
251 | repositories {
252 | mavenCentral()
253 | // maven {
254 | // url 'http://dl.bintray.com/danielemaddaluno/maven/'
255 | // }
256 | }
257 | compile 'com.github.danielemaddaluno.androidupdatechecker:library:+'
258 | }
259 | ```
260 | If you use the default of Android Studio, jcenter() you could simply import like this (for me it doesn't work without the exactly version, i.e. with the plus gives me an error)
261 | ``` gradle
262 | dependencies {
263 | compile 'com.github.danielemaddaluno.androidupdatechecker:library:1.0.3'
264 | }
265 | ```
266 | **Automatically with Maven**
267 | ``` xml
268 |
269 |
270 | ...
271 |
272 |
273 | danielemaddaluno
274 | Daniele Maddaluno Bintray Repository
275 | http://dl.bintray.com/danielemaddaluno/maven/
276 |
277 |
278 | ...
279 |
280 |
281 | com.github.danielemaddaluno.androidupdatechecker
282 | library
283 | 1.0.0
284 |
285 |
286 | ...
287 |
288 | ```
289 |
--------------------------------------------------------------------------------