new_module

Module Addition Rules for sentry-java

Overview

This document outlines the complete process for adding a new module to the sentry-java repository. Follow these steps in order to ensure proper integration and release management.

Publishing Gate

Nothing below is enforced by the build, so a module can look finished, pass CI, and still break the release that first ships it. All of the following have to be merged before that release:

• The module is in the include list in settings.gradle.kts (step 1.2)
• Android (AAR) modules are in Config.BuildScript.androidLibs (step 1.4)
• The module has a row in the packages table in the main README.md (step 3)
• The module is in the integrations dropdown of the matching issue template (step 4)
• The docs page exists on docs.sentry.io (step 5), because .craft.yml has to point at a live URL
• The module has a full entry in the registry target of .craft.yml (step 6) — this one fails the release itself, not just the module

Step-by-Step Process

1. Create the Module Structure

1. Create the new module, conforming to the existing naming conventions and build scripts. Copy the build.gradle.kts of the closest existing integration rather than writing one from scratch — sentry-kafka is a good JVM template, sentry-android-timber a good Android one.

2. Add the module to the include list in settings.gradle.kts

If adding a sentry-samples module, also add it to the ignoredProjects list in the root build.gradle.kts:

ignoredProjects.addAll(
    listOf(
        // ... existing projects ...
        "sentry-samples-{module-name}"
    )
)

1. Add a SENTRY_{MODULE}_SDK_NAME constant to the Config.Sentry block in buildSrc/src/main/java/Config.kt:

val SENTRY_FOO_SDK_NAME = "$SENTRY_JAVA_SDK_NAME.foo"

The module's build.gradle.kts consumes it in both buildConfig and the jar manifest (Sentry-SDK-Name / Sentry-SDK-Package-Name) — see sentry-kafka/build.gradle.kts.