Skip to content
This repository was archived by the owner on Apr 1, 2025. It is now read-only.

Conversation

daveo89
Copy link
Contributor

@daveo89 daveo89 commented Dec 26, 2024

Add Android ProGuard configuration for AssemblyAI SDK

Add necessary ProGuard keep rules to README.md to ensure proper functionality of the AssemblyAI SDK when code shrinking is enabled in Android release builds.

This documentation helps developers avoid potential runtime issues when using the SDK with minification enabled.

Add Android ProGuard configuration for AssemblyAI SDK

Add necessary ProGuard keep rules to README.md to ensure proper 
functionality of the AssemblyAI SDK when code shrinking is enabled 
in Android release builds.

This documentation helps developers avoid potential runtime issues 
when using the SDK with minification enabled.
@marcusolsson
Copy link
Contributor

Thank you for you contribution! I'm not familiar with ProGuard (or Android development in general) so I'll need to read up before I can accept the PR. Could you maybe give a bit more detail to help me understand the change? Maybe link to relevant documentation?

@marcusolsson marcusolsson added triage/needs-investigation Issue needs investigation before it can be confirmed. kind/documentation Improvements or additions to documentation labels Jan 7, 2025
@daveo89
Copy link
Contributor Author

daveo89 commented Jan 7, 2025

Thank you for replying.
Sure, here's the link to the official Android documentation, which should help demystify the topic. Another thing worth considering is a dedicated ProGuard configuration for the JAR library (see the 'Library dependencies' section).
Nevertheless, the majority of Android apps enable R8 functionality in the release version, and using third-party SDKs without a proper ProGuard setup might lead to runtime crashes in production without a clear explanation. That’s why a proper R8 configuration is necessary, either on the client side or within the library.

Copy link
Contributor

@marcusolsson marcusolsson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the links and for clarifying 🙏

@marcusolsson marcusolsson merged commit 9f73332 into AssemblyAI:main Jan 10, 2025
@marcusolsson
Copy link
Contributor

Thank you for taking the time to contribute and walk me through this! 🙏 🙏

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/documentation Improvements or additions to documentation triage/needs-investigation Issue needs investigation before it can be confirmed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants