Skip to content

embrace-io/embrace-android-sdk

Repository files navigation

Embrace

The Embrace Android SDK provides instrumentation for Android apps.

codecov android api build

Getting Started

⚠️ This is for native android apps: Leverage in our Unity, ReactNative and Flutter SDKs for cross-platform apps

Upgrading from 5.x

Follow our upgrading guide

Usage

  • Refer to our Features page to learn about the features Embrace SDK provides

Support

Development

Code Formatting

In most of our repos we are using Detekt to analyse our kotlin code. This analysis should be done before the new code is merged to master. It’s considered a good practice to run the command before pushing our code. Github workflows will also be running this check.

To run the check locally, you can run the following command in the root directory of the project:

./gradlew detekt

n some cases, the errors get fixed just by running the command, so if you run it again, you could get less errors than the first time. As a result, it will list the errors and you need to go and fix them if you consider appropriate.

You can run the command until you get no errors or until you get only the errors you don’t want to fix.

If you have errors you want to ignore, you need to run:

./gradlew detektBaseline

This command will add a line per error to be ignored into the baseline.xml file. This way, this file will be updated and the code smell will be also ignored by Github Workflows.

License

See the LICENSE for details.