Publish android library with Github + JitPack

Trong bài viết này mình sẽ hướng dẫn các bạn cách đơn giản để chia sẻ thư viện android mà chính mình code lên Github.

Lợi ịch của việc publish Android Library:

  1. Dễ dàng quản lý code
  2. Truy cập vào thư viện dễ dàng
  3. Dùng được cho mọi dự án

Các bước tạo và publish một thư viện android:

  1. Tạo 1 project android trên android studio
  2. Tạo 1 module làm thư viện
  3. Code nội dung thư viện
  4. Share project lên Github
  5. Release code trên Github
  6. Connect đến JitPack để public
  7. Update README.md

Dưới đây là hướng dẫn cơ bản các bước:

  1. Tạo Project:
    – Sử dụng : Android Studio phiên bản Jellyfish
    – New Project sử dụng style Kotlin DLS

2. Tạo module làm thư viện

File ->New ->New Module ->Android Library

  • Thêm module vào project: settings.gradle.kts
include(":permissions")
  • implementation vào: build.gradle.kts
    implementation (project( ":permissions"))

3. Code nội dung thư viện

Trong thư viện này mình sẽ code phần logic xin quyền trong android với trung gian là một lớp Dialog Fragment

Cập nhật code liên quan đến phần publish library

Tại build.gradle.kts của thư viện tiến hành thêm code như sau:

plugins {
    ...
    id("maven-publish")
}

android {
    namespace = "com.app.permissions"
    compileSdk = 34

    defaultConfig {
        minSdk = 23
        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
    }
  ...
}

...
publishing {
    publications {
        register<MavenPublication>("release") {
            afterEvaluate {
                from(components["release"])
            }
        }
    }
}

4. Tiến hành publish code lên Github

VCS -> Share Project On GitHub

Project trên git: https://github.com/nguyenlinhnttu/AndroidPermissionNewApi

5. Release code trên Github

  • Đầu tiên cần tạo tag cho việc release.
    Trên android studio chọn Git -> New Tag ->Create Tag
  • Trên Github vào mục Releases để release code.

6. Kết nối đến JitPack

Nhập repo của chúng ta vào chọn Look up

Ở phần Version , chọn version cần release nhấn Get it.

Màu xanh nghĩa là bạn đã release thành công.

Nếu màu đỏ thì bấm vào Log để xem lỗi

JitPack sẽ tạo cho chúng ta phần How to để sử dụng thư viện.

7. Update README.md

Quay lại Repo trên Github tiến hành update file Readme.MD để hướng dẫn người dùng sử dụng thư viện

Dưới đây là thư viện hoàn chỉnh mà mình đã publish:

https://github.com/nguyenlinhnttu/AndroidPermissionNewApi

Nguyễn Linh

Chia sẻ để cùng tiến bộ...