ankidroid/Anki-Android

APK size optimization umbrella (remaining task: size comparison on PRs)

Open

Aperta il 20 giu 2024

Vedi su GitHub
 (5 commenti) (1 reazione) (0 assegnatari)Kotlin (11.132 star) (2789 fork)batch import
CIDevEnhancementHelp WantedKeep Open

Descrizione

Examine APK size on release builds, should be as small as possible

Currently has some bloat in there

(Optional) Anything else you want to share?

  • there is an APK size comparison tool but it doesn't run all the time (yet) #16613
  • there is proguard and release builds are set to optimize, but the proguard rules are currently not aggressive at all
  • we are not testing release builds in CI so changing proguard settings is dangerous until fixed (tracking in #16625 )

So, idea is:

  • test release builds in CI so changes to proguard get some validation
    • #16635
  • alter emulator test workflow to post release APK artifact for main merges (so we have current baseline size)
    • future enhancement
  • alter emulator test workflow to compare current posted main APK size with current release build size (ingesting compare size workflow logic...) and posting results (currently a comment, but as a status would be better in future
    • future enhancement
  • start changing proguard rules and verifying app still runs
    • #16635
  • also do APK inspection (Android Studio has a good tool) which can help find ridiculous things
    • anyone can pick this up after #16635 merges

Additionally, may make sense to examine Anki-Android-Backend, there are some thoughts on a previous effort #8473

  • anyone can pick this up if they like

Guida contributor

Tech stack
kotlinandroid
Dominio
mobileperformanceci cd
Tipo issue
performance
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
4
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
over 1 week
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Android developmentProGuard configurationCI/CD workflows
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
25
Direzione di ricerca
The issue is an umbrella with multiple sub tasks. Start by understanding the current CI pipeline (look at .github/workflows) and the existing ProGuard rules in app/proguard rules.pro. Then examine linked issues #16613 (APK size comparison tool), #16625 (release build testing), and #16635 (integrate release build tests). The goal is to enable more aggressive ProGuard and automate APK size comparison on PRs. For a concrete first step, consider setting up a workflow to build a release APK and measure its size.