Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Make MiMa aware of @akka.annotation.ApiMayChange / @akka.annotation.InternalApi

See original GitHub issue

We introduced a few annotations to mark that a given type should not matter when checking bin-compat:

@ApiMayChange - API still not quite stable, will change
@InternalAPI - internal API, can change however it wants to
@DoNotInherit - no one except the same library which provides this class should extend this class

Full types: https://github.com/akka/akka/pull/22110/files Example usage: https://github.com/akka/akka/issues/22109

MiMa could check if a type has annotations and if the name matches these then it can ignore warnings about a given type or method.

Issue Analytics

State:
Created 7 years ago
Reactions:1
Comments:7 (7 by maintainers)

Top GitHub Comments

2reactions

ktosocommented, Jan 6, 2017

Yeah, would be very cool 😃 I may hack on this… Would save us a lot of explaining to contributors who touch these classes.

0reactions

SethTisuecommented, Aug 2, 2022

Note that #647 only implements this for Scala 3, not for Scala 2.

(Because anything involving unpickling must be separately implemented, since Scala 3’s pickle format is completely different, being TASTy-based.)

Top Results From Across the Web

Akka 2.6.20 - akka.annotation - Documentation

trait ApiMayChange extends Annotation. Annotations: @Documented() @Retention() @Target() · trait DoNotInherit extends Annotation.

CONTRIBUTING.md ... - GitCode

The goal of these notes is to make your experience contributing to Akka as ... new subproject) and marking it's public api with...

sbt Reference Manual — Combined Pages

The Getting Started Guide covers the concepts you need to know to create and ... Let's get rid of += first, and annotate...

Akka A to Z: The Industry's Choice For Fast Data ... - YouTube

The Akka toolkit makes all of this simple for Java and Scala developers at Amazon, LinkedIn, Starbucks, Verizon and others.

akka.annotation.ApiMayChange.<init> java code examples

public static final StatusCode PROCESSING = akka.http.scaladsl.model.StatusCodes.Processing(); @ApiMayChange public static final StatusCode EARLY_HINTS ...