protocolbuffers/protobuf

Include valid proguard config in java protolite library

Open

#11,252 opened on Dec 12, 2022

View on GitHub
 (2 comments) (0 reactions) (1 assignee)C++ (16,128 forks)batch import
help wantedjava

Repository metrics

Stars
 (71,223 stars)
PR merge metrics
 (Avg merge 2d 11h) (185 merged PRs in 30d)

Description

Related to

https://issuetracker.google.com/issues/144631039 and https://github.com/protocolbuffers/protobuf/issues/6463

What language does this apply to?

Java Protolite

Describe the problem you are trying to solve.

Include necessary proguard definitions to avoid failures in release builds.

Describe the solution you'd like

Include https://github.com/protocolbuffers/protobuf/blob/520c601c99012101c816b6ccc89e8d6fc28fdbb8/java/lite/proguard.pgcfg in the library, so it's applied automatically.

See https://github.com/square/okhttp/blob/master/docs/features/r8_proguard.md for how this feature works in other libraries

https://raw.githubusercontent.com/square/okhttp/master/okhttp/src/jvmMain/resources/META-INF/proguard/okhttp3.pro

Describe alternatives you've considered

Currently every app needs to fail initially, search for the error message and include the same fix.

Contributor guide

Research direction
Investigate the existing proguard.pgcfg file in java/lite/. Understand how the protolite library is built (likely with Maven or Gradle). Follow the pattern from OkHttp (referenced in the issue) to automatically include the proguard configuration in the library artifact under META INF/proguard/. Modify the build files accordingly.
Tech stack
java
Domain
mobile
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaGradle
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65