It contains a -keep class com.google.gson.examples.android.model.** entry which is only relevant for that example
It contains a confusing -keep class com.google.gson.stream.**, see #1571
It is possibly incomplete and redundant nowadays since there is now META-INF/proguard/gson.pro (which users can also use as reference if they are using Gson < 2.11.0, which does not include that file)
It contains the file default.properties which is probably redundant nowadays
It also contains little configuration or code which is Android specific; the most important part is probably proguard.cfg. GsonProguardExampleActivity.java just performs basic conversion from and to JSON and displays the result as text; it does not use SharedPreferences, Room, or communicate with a REST API or anything similar.
Side note: After creating a new empty project in Android Studio, adding the files from the example and making some small adjustments the project still works though.
Feature description
Remove examples/android-proguard-example
Optionally consider adding Android (or generally R8 / ProGuard) information to the User Guide instead
Replace references to examples/android-proguard-example
Alternatives / workarounds
An alternative would be to fix the issues above, or even set up a new sample Android project following the current best practices. However, the risk is that this becomes outdated again in the next years.
Alternatively could also just do nothing (or maybe only fix some of the issues), but the question is then how much value examples/android-proguard-example in its current form provides to users.
Problem solved by the feature
This repository currently contains an Android sample project in
examples/android-proguard-example. The README and Troubleshooting Guide currently refer to it, and as seen by https://github.com/google/gson/discussions/2715#discussioncomment-10119789 users are still looking at it often.The problem is that this sample project is quite old, and might not represent current best practices:
src/main/java, ... conventionsicon.pngwhich is probably not best practice; nowadays Android apps normally use vector drawablesCart#toStringimplementation seems to contain debug code which is not relevant to usersproguard.cfgproguard-rules.pro, see https://developer.android.com/build/shrink-code-keep class com.google.gson.examples.android.model.**entry which is only relevant for that example-keep class com.google.gson.stream.**, see #1571META-INF/proguard/gson.pro(which users can also use as reference if they are using Gson < 2.11.0, which does not include that file)default.propertieswhich is probably redundant nowadaysAndroidManifest.xmlcontainspackage="...", which is ignored by recent Android Gradle Plugin versions, see https://developer.android.com/guide/topics/manifest/manifest-element#packageIt also contains little configuration or code which is Android specific; the most important part is probably
proguard.cfg.GsonProguardExampleActivity.javajust performs basic conversion from and to JSON and displays the result as text; it does not useSharedPreferences, Room, or communicate with a REST API or anything similar.Side note: After creating a new empty project in Android Studio, adding the files from the example and making some small adjustments the project still works though.
Feature description
examples/android-proguard-exampleexamples/android-proguard-exampleAlternatives / workarounds
An alternative would be to fix the issues above, or even set up a new sample Android project following the current best practices. However, the risk is that this becomes outdated again in the next years.
Alternatively could also just do nothing (or maybe only fix some of the issues), but the question is then how much value
examples/android-proguard-examplein its current form provides to users.