빌드와 배포

StarLight Gradle 플러그인(io.github.mooner1022.slplugin)은 플러그인 APK를 .slp로 묶고, StarLight가 불러올 때와 같은 기준으로 검사하고, adb로 기기에 올려요. StarLight가 실행 중에야 알려 주던(또는 조용히 무시하던) 문제를 빌드 오류로 미리 알 수 있어요.

태스크#

평소에는 이렇게 반복하면 돼요.

./gradlew deployDebugSlp -Pstarlight.restartApp=true
./gradlew starlightLogcat

기기 지정#

deploy { device }에는 adb -s에 넘길 수 있는 값을 적어요. 기기가 하나만 연결되어 있다면 생략해도 돼요.

starlight {
    deploy {
        device = "192.168.0.10:5555"   // adb 시리얼 또는 ip:port
        // restartApp = true           // 배포 후 StarLight를 다시 시작
    }
}

• 무선 디버깅은 adb pair <ip>:<port>로 한 번 페어링한 뒤 무선 디버깅 화면의 주소를 쓰세요. ip:port 값이면 Gradle 플러그인이 adb connect를 대신 실행해요.
• 개인 주소를 빌드 스크립트에 남기고 싶지 않다면 -Pstarlight.device=...나 환경 변수 STARLIGHT_DEVICE를 쓰세요. 둘 다 빌드 스크립트보다 우선해요.
• restartApp은 기기의 StarLight를 강제 종료해요. 매번 다시 시작하지 않으려면 빌드 스크립트에서는 꺼 두고 -Pstarlight.restartApp=true로 필요할 때만 켜세요.

검사 항목#

검사 규칙은 StarLight가 플러그인을 읽고 불러오는 방식과 같아요(Gradle 플러그인 0.3.0 기준).

• starlight.json이 assets/에 있고 BOM이 없는지. api_version이 0.3.x라면 {로 시작해 }로 끝나고 앞뒤에 빈 줄이 없는지도 확인해요.
• 필수 키(id, name, main_class, version, api_version, authors, description)와 그 형식
• 버전이 major.minor.patch[.build] 형식인지
• api_version이 앱이 불러오는 범위(0.3.0 이상, 앱의 PluginCore 이하)인지. Gradle 플러그인이 아는 가장 새 PluginCore는 1.0.0이라, 더 높은 값은 경고만 해요.
• id가 영문, 숫자, ., _, -로만 이루어졌고 예약어(global, starlight, system, core)가 아닌지(오류)
• category가 문자열인지, 알려진 카테고리인지(모르는 값은 경고)
• 의존성 문자열 형식(id, id@1.2.3, id@*?)과 ?만 붙은 선택 의존성
• 모르는 키(경고), 예전 키 depend(오류)
• main_class가 APK 안에 있고, public이고, 추상 클래스가 아니며, StarlightPlugin을 상속하고, 인자 없는 public 생성자가 있는지
• uses_native_lib가 실제 .so 파일 포함 여부와 맞는지
• 앱이 제공하는 라이브러리(PluginCore, ConfigDSL, Kotlin, 주요 AndroidX, Material)를 플러그인에 넣었는지(경고)

참고 사항#

• 난독화 — R8을 켠다면 진입점 클래스를 남겨 두세요. excludeHostKotlinLibraries를 켰다면 -dontwarn kotlin.**도 필요할 수 있어요.

  -keep class com.example.MyPlugin { public <init>(); }

• 서명 — StarLight는 플러그인 서명을 확인하지 않아서, 서명하지 않은 release 빌드도 동작해요.

• ABI 분할 — ABI별로 APK를 나누면 <id>-<variant>-<abi>.slp가 각각 만들어지고, 배포할 때 기기에 맞는 파일을 골라요.

• 같은 ID의 파일 — plugins/ 폴더에 ID가 같은 .slp가 여럿 있으면 StarLight는 version이 가장 높은 것을 불러오고 나머지는 제외해요. 배포 태스크는 <id>.slp로 저장하므로, 다른 이름으로 남아 있는 예전 파일은 지워 주세요.

• 구성 캐시 — Gradle 플러그인 0.3.0은 Gradle 구성 캐시(configuration cache)와 함께 쓸 수 있어요.

0.2.0에서 올리기#

• 플러그인 ID에 영문, 숫자, ., _, - 외의 문자가 있으면 이제 오류예요(이전에는 경고). PluginCore 1.0.0 앱이 이런 플러그인을 불러오지 않기 때문이에요.
• api_version을 앱의 major.minor 대신 앱이 불러오는 범위로 검사해요. 1.0.0도 더 이상 경고하지 않아요.
• 필요하면 manifest { }에 category를 추가하세요.

문제 해결#

플러그인이 앱에 보이지 않거나 켜지지 않으면 starlightLogcat에서 아래 메시지를 찾아보세요.

빌드 결과물에 문제가 있다면 먼저 Gradle 플러그인의 검사 결과를 확인하세요. 대부분은 빌드 단계에서 잡혀요.