Skip to main content

Publish your library to JitPack

Once getting inside the open source concept, the idea and desire to publish a library is inevitable. What you need is an idea, or perhaps make a better version of an existing library, or just you need to use some module inside your company for several projects.

With the JitPack, you won't be suffering at all. So how do you do it? For the sake of this tutorial, I'm just gonna make a logging library.

Note: This article assumes you already know how to use git.

Once you have your IDE opened, create a new project. Since I am using Android Studio, I'm gonna choose an Android app but you can do the same (I guess, never done it) with on Java/Kotlin projects and IntelliJ. Nothing new here. So let's jump further. Once the project is created, create a new module:

After that, you can choose whatever you need, but for this article I'm gonna stick to Android library. 

Give it a name, and the library is ready to be coded. If you notice, in your project, the module will be added:

Now, let's code. I'm going to create an awesome method that logs something in the console, wow. Since I'm using Kotlin, I won't be needing a new class, but if you use Java, create a new class.

For local usage, you don't need to publish to JitPack, but I am skipping this part here.

Git time

First of all, create a new repository. Don't forget to add an open source license.

Now, just normally add your project to via console or git client that you might be using. Please note that if you create a license and a README file, you are going to have to git pull first and then push your project into the repo

Time to publish:
Once your project is super ready for production, go to releases (normally you would have 0 for the moment):

Well, give the release a name, a version and some description.

If you have reached something like the below photo, your library is ready for JitPack:

So, let's jump to JitPack. Just add the repo url and let JitPack handle generation for you.

Once a version is found by JitPack, it will generate the code to be imported from you or other people who will use this library:

That's it. If you follow those steps, you are ready to use the library. And indeed you are:

Choosing an Android library for cases like this, might be redundant. That's because doing so, the IDE will also create Android Packages along with Java or Kotlin packages. Instead you should stick to Java/Kotlin libraries.

Good luck!

Popular posts from this blog

What I learned from Kotlin Flow API

I used to check the docs and just read a lot about flows but didn't implement anything until yesterday. However, the API tasted really cool (even though some operations are still in Experimental state).Prerequisites: If you don't know RxJava it's fine. But a RxJava recognizer would read this faster.Cold vs Hot streamsWell, I really struggled with this concept because it is a little bit tricky. The main difference between cold and hot happened to be pretty simple: Hot streams produce when you don't care while in cold streams, if you don't collect() (or RxJava-s equivalent subscribe()) the stream won't be activated at all. So, Flows are what we call cold streams. Removing the subscriber will not produce data at all, making the Flows one of the most sophisticated asynchronous stream API ever (in the JVM world). I tried to make a illustration of hot and cold streams: Since I mentioned the word asynchronous this implies that they do support coroutines also. Flows vs…

Modularizing your Android app, breaking the monolith (Part 1)

Inspired by a Martin Fowlers post about Micro Frontends, I decided to break my monolithic app into a modular app. I tried to read a little more about breaking monolithic apps in Android, and as far as I got, I felt confident to share my experience with you. This will be some series of blog posts where we actually try to break a simple app into a modularized Android app.

Note: You should know that I am no expert in this, so if there are false statements or mistakes please feel free to criticize, for the sake of a better development. 

What do you benefit from this approach:
Well, people are moving pretty fast nowadays and delivery is required faster and faster. So, in order to achieve this, modularising Android apps is really necessary.You can share features across different apps. Independent teams and less problems per each.Conditional features update.Quicker debugging and fixing.A feature delay doesn't delay the whole app. As per writing tests, there is not too much difference about…

From Gson to Moshi, what I learned

There is no doubt that people are getting away from GSON and I agree with those reasons too. The only advantage GSON has over other parsing libraries is that it takes a really short amount of time to set up. Furthermore, the most important thing is that Moshi is embracing Kotlin support.

First let's implement the dependency:
implementation("com.squareup.moshi:moshi:1.8.0") It's not a struggle to migrate to Moshi. It's really Gson look-a-like. The only thing to do is annotate the object with @field:Json instead of @SerializedName (which is Gsons way for JS representation):

data class User( //GSON way @SerializedName("name") val name: String, @SerializedName("user_name") val userName: String, @SerializedName("last_name") val lastName: String, @SerializedName("email") val email: String ) data class User( //Moshi way @field:Json(name = "name") val name: String, @field:Json(name = "user_name…