getsentry / getsentry/sentry-java

Add japicmp to sentry-java for API compatibility checks

Open
#5,669 1 comment 0 reactions 0 assignees View on GitHub
Java Platform: Java Tests
Dominant language
Kotlin
Stars
1.4k
Forks
478
Avg merge
2d 23h
Merged PRs (30d)
67

Description

## Context

getsentry/sentry-java#5653 (getsentry/sentry-java#5653) raised the question of whether japicmp ([https://github.com/siom79/japicmp]()) could help us catch API compatibility issues like the missing `@Throws` on `SentryOkHttpInterceptor.intercept()`.

For example: we should compare SentryOkHttp to Oktthp and SentryTimber to Timber.

Contributor guide

Open the contributing guide

Research direction

Start by reading getsentry/sentry-java#5653 and the japicmp documentation to understand the proposed API compatibility checks. Locate the repository build configuration and the modules containing SentryOkHttp and SentryTimber, then determine how to compare them with OkHttp and Timber. Done means compatibility checks cover the named APIs and run as part of the project build.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, kotlin
Domain
build-system, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.