UploadToJitpack

Additional

Language
Kotlin
Version
N/A
Created
Jun 27, 2016
Updated
Feb 13, 2022
Owner
Nishant Srivastava (nisrulz)
Contributor
Nishant Srivastava (nisrulz)
1
Activity
Badge
Generate
Download
Source code

Promotion

Upload to JitPack

Specs

Featured in

Show some ❤️


Base repository to demonstrate the process of uploading an aar/jar to JitPack.

Blog Post : Guide to publishing your Android Library via JitPack

The process is as follows

  1. Create an Android project or open an existing one in Android Studio

  2. Init the project with git and also create a repo on Github for the same. Each step here onwards represent a commit and should be pushed to github.

  3. Create and add a new module and choose Android Library.

    Goto File>New>New Module.. and select Android Library.

  4. Implement your library code inside the library module you created in the last step.

  5. Next add the library module as a dependency to the app module.

    • Goto File>Project Structure..
    • Select app module in the sidebar
    • Select the Dependencies tab
    • At the bottom is a + icon, click that and select Module dependency and select your library module.
    • Press apply or ok.
  6. Next, apply the maven-publish plugin to the build.gradle file at library module level. Also add the group variable along with version info.

    apply plugin: 'com.android.library'
    
    // Required plugin in library module for publishing
    apply plugin: 'maven-publish'
    
    // Replace nisrulz with <your_github_username>
    final group = "com.github.nisrulz"
    final artifact = "awesomelib"
    final versionCode = 1
    final versionName = "1.0"
  7. Next add publishing config block

    // Because the components are created only during the afterEvaluate phase, you must
    // configure your publications using the afterEvaluate() lifecycle method.
    afterEvaluate {
        publishing {
            publications {
                // Creates a Maven publication called "release".
                release(MavenPublication) {
                    // Applies the component for the release build variant.
                    from components.release
    
                    // You can then customize attributes of the publication as shown below.
                    groupId = group
                    artifactId = artifact
                    version = versionName
                }
    
                // Creates a Maven publication called “debug”.
                debug(MavenPublication) {
                    // Applies the component for the debug build variant.
                    from components.debug
    
                    groupId = group + ".debug"
                    artifactId = artifact + "-debug"
                    version = versionName
                }
            }
        }
    }

    Test everything builds and artifacts are published to Maven Local by running ./gradlew publishToMavenLocal at the root of the project.

  8. Create a jitpack.yml file at the root of your project and add below config:

    jdk:
     - openjdk11

    This is needed because from AGP 7.0 onwards JDK 11 is required for the build to succeed.

  9. Create a release TAG in git

    git tag -a 1.0 -m "v1.0"
    git push origin 1.0
  10. Once everything is pushed and the release TAG is also pushed, goto https://www.jitpack.io/#username/reponame where replace username with your github username and reponame with the reponame of the android project.

  11. Select the release you would like to share by clicking the ‘Get It’ button next to the list of releases of your repository.

  12. Next the same page at Jitpack would show you how to use the library in your other android projects. Something like below

    repositories {
      google()
      mavenCentral()
      maven { url “https://jitpack.io” }
    }
    dependencies {
      compile 'com.github.nisrulz:awesomelib:1.0'
    }
  13. Let the world know of your AwesomeLib 😄

    • Add a readme that explains how to integrate and use your Awesome library
    • Add a license block as in this repo
    • Also include the JitPack badge provided by jitpack in your readme
    • Promote your lib on social media so that others can know about it.
    • Always add a working sample app in your project that demonstrates your library in use.
    • Add screenshots if possible in your readme.

If you appreciate my work, consider buying me a cup of to keep me recharged 🤘 [PayPal]

License

Copyright 2016 Nishant Srivastava

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.