Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: set up binary compatibility validator #1064

Merged
merged 5 commits into from
Dec 7, 2023
Merged

build: set up binary compatibility validator #1064

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bc8a8d3
Apply org.jetbrains.kotlinx.binary-compatibility-validator
Goooler Dec 6, 2023
dadeb86
Run `./gradlew apiDump`
Goooler Dec 6, 2023
5625147
Merge branch 'spotbugs:master' into set-up-kt-api-validator
Goooler Dec 6, 2023
572b597
Ignore internal APIs
Goooler Dec 7, 2023
32bd65b
Use `+=`
Goooler Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
225 changes: 225 additions & 0 deletions api/spotbugs-gradle-plugin.api
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
public abstract class com/github/spotbugs/snom/Confidence : java/lang/Enum {
public static final field DEFAULT Lcom/github/spotbugs/snom/Confidence;
public static final field HIGH Lcom/github/spotbugs/snom/Confidence;
public static final field LOW Lcom/github/spotbugs/snom/Confidence;
public static final field MEDIUM Lcom/github/spotbugs/snom/Confidence;
public synthetic fun <init> (Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
public static fun getEntries ()Lkotlin/enums/EnumEntries;
public abstract fun toCommandLineOption ()Ljava/util/Optional;
public static fun valueOf (Ljava/lang/String;)Lcom/github/spotbugs/snom/Confidence;
public static fun values ()[Lcom/github/spotbugs/snom/Confidence;
}

public final class com/github/spotbugs/snom/Effort : java/lang/Enum {
public static final field DEFAULT Lcom/github/spotbugs/snom/Effort;
public static final field LESS Lcom/github/spotbugs/snom/Effort;
public static final field MAX Lcom/github/spotbugs/snom/Effort;
public static final field MIN Lcom/github/spotbugs/snom/Effort;
public static final field MORE Lcom/github/spotbugs/snom/Effort;
public static fun getEntries ()Lkotlin/enums/EnumEntries;
public static fun valueOf (Ljava/lang/String;)Lcom/github/spotbugs/snom/Effort;
public static fun values ()[Lcom/github/spotbugs/snom/Effort;
}

public final class com/github/spotbugs/snom/ExtensionsKt {
public static final fun assignConfidence (Lorg/gradle/api/provider/Property;Ljava/lang/String;)V
public static final fun assignEffort (Lorg/gradle/api/provider/Property;Ljava/lang/String;)V
}

public final class com/github/spotbugs/snom/SpotBugsBasePlugin : org/gradle/api/Plugin {
public static final field Companion Lcom/github/spotbugs/snom/SpotBugsBasePlugin$Companion;
public fun <init> ()V
public synthetic fun apply (Ljava/lang/Object;)V
public fun apply (Lorg/gradle/api/Project;)V
public final fun loadProperties ()Ljava/util/Properties;
public final fun verifyGradleVersion (Lorg/gradle/util/GradleVersion;)V
}

public final class com/github/spotbugs/snom/SpotBugsBasePlugin$Companion {
}

public abstract interface class com/github/spotbugs/snom/SpotBugsExtension {
public abstract fun getBaselineFile ()Lorg/gradle/api/file/RegularFileProperty;
public abstract fun getEffort ()Lorg/gradle/api/provider/Property;
public abstract fun getExcludeFilter ()Lorg/gradle/api/file/RegularFileProperty;
public abstract fun getExtraArgs ()Lorg/gradle/api/provider/ListProperty;
public abstract fun getIgnoreFailures ()Lorg/gradle/api/provider/Property;
public abstract fun getIncludeFilter ()Lorg/gradle/api/file/RegularFileProperty;
public abstract fun getJvmArgs ()Lorg/gradle/api/provider/ListProperty;
public abstract fun getMaxHeapSize ()Lorg/gradle/api/provider/Property;
public abstract fun getOmitVisitors ()Lorg/gradle/api/provider/ListProperty;
public abstract fun getOnlyAnalyze ()Lorg/gradle/api/provider/ListProperty;
public abstract fun getProjectName ()Lorg/gradle/api/provider/Property;
public abstract fun getRelease ()Lorg/gradle/api/provider/Property;
public abstract fun getReportLevel ()Lorg/gradle/api/provider/Property;
public abstract fun getReportsDir ()Lorg/gradle/api/file/DirectoryProperty;
public abstract fun getShowProgress ()Lorg/gradle/api/provider/Property;
public abstract fun getShowStackTraces ()Lorg/gradle/api/provider/Property;
public abstract fun getToolVersion ()Lorg/gradle/api/provider/Property;
public abstract fun getUseAuxclasspathFile ()Lorg/gradle/api/provider/Property;
public abstract fun getUseJavaToolchains ()Lorg/gradle/api/provider/Property;
public abstract fun getVisitors ()Lorg/gradle/api/provider/ListProperty;
}

public final class com/github/spotbugs/snom/SpotBugsPlugin : org/gradle/api/Plugin {
public static final field CONFIG_NAME Ljava/lang/String;
public static final field Companion Lcom/github/spotbugs/snom/SpotBugsPlugin$Companion;
public static final field EXTENSION_NAME Ljava/lang/String;
public static final field PLUGINS_CONFIG_NAME Ljava/lang/String;
public static final field SLF4J_CONFIG_NAME Ljava/lang/String;
public fun <init> ()V
public synthetic fun apply (Ljava/lang/Object;)V
public fun apply (Lorg/gradle/api/Project;)V
}

public final class com/github/spotbugs/snom/SpotBugsPlugin$Companion {
}

public abstract class com/github/spotbugs/snom/SpotBugsReport : org/gradle/api/reporting/CustomizableHtmlReport, org/gradle/api/reporting/SingleFileReport {
public fun <init> (Lorg/gradle/api/model/ObjectFactory;Lcom/github/spotbugs/snom/SpotBugsTask;)V
public synthetic fun configure (Lgroovy/lang/Closure;)Ljava/lang/Object;
public fun configure (Lgroovy/lang/Closure;)Lorg/gradle/api/reporting/Report;
public final fun configure (Lorg/gradle/api/Action;)Lorg/gradle/api/reporting/Report;
public final fun getDestination ()Ljava/io/File;
public fun getDisplayName ()Ljava/lang/String;
public fun getOutputLocation ()Lorg/gradle/api/file/RegularFileProperty;
public synthetic fun getOutputLocation ()Lorg/gradle/api/provider/Property;
public fun getOutputType ()Lorg/gradle/api/reporting/Report$OutputType;
public fun getRequired ()Lorg/gradle/api/provider/Property;
public fun getStylesheet ()Lorg/gradle/api/resources/TextResource;
protected final fun getTask ()Lcom/github/spotbugs/snom/SpotBugsTask;
public final fun isEnabled ()Z
public fun setDestination (Ljava/io/File;)V
public final fun setDestination (Lorg/gradle/api/provider/Provider;)V
public final fun setEnabled (Lorg/gradle/api/provider/Provider;)V
public final fun setEnabled (Z)V
public fun setStylesheet (Ljava/lang/String;)V
public fun setStylesheet (Lorg/gradle/api/resources/TextResource;)V
public abstract fun toCommandLineOption ()Ljava/lang/String;
}

public abstract class com/github/spotbugs/snom/SpotBugsTask : org/gradle/api/DefaultTask, org/gradle/api/tasks/VerificationTask {
public fun <init> ()V
public abstract fun getAnalyseClassFile ()Lorg/gradle/api/file/RegularFileProperty;
public abstract fun getAuxClassPaths ()Lorg/gradle/api/file/ConfigurableFileCollection;
public abstract fun getAuxclasspathFile ()Lorg/gradle/api/file/RegularFileProperty;
public final fun getBaseName ()Ljava/lang/String;
public abstract fun getBaselineFile ()Lorg/gradle/api/file/RegularFileProperty;
public abstract fun getClassDirs ()Lorg/gradle/api/file/ConfigurableFileCollection;
public final fun getClasses ()Lorg/gradle/api/file/FileCollection;
public abstract fun getEffort ()Lorg/gradle/api/provider/Property;
public abstract fun getExcludeFilter ()Lorg/gradle/api/file/RegularFileProperty;
public abstract fun getExtraArgs ()Lorg/gradle/api/provider/ListProperty;
public fun getIgnoreFailures ()Z
public abstract fun getIncludeFilter ()Lorg/gradle/api/file/RegularFileProperty;
public abstract fun getJvmArgs ()Lorg/gradle/api/provider/ListProperty;
public abstract fun getLauncher ()Lorg/gradle/api/provider/Property;
public abstract fun getMaxHeapSize ()Lorg/gradle/api/provider/Property;
public abstract fun getOmitVisitors ()Lorg/gradle/api/provider/ListProperty;
public abstract fun getOnlyAnalyze ()Lorg/gradle/api/provider/ListProperty;
public abstract fun getPluginJarFiles ()Lorg/gradle/api/file/ConfigurableFileCollection;
public abstract fun getProjectName ()Lorg/gradle/api/provider/Property;
public abstract fun getRelease ()Lorg/gradle/api/provider/Property;
public abstract fun getReportLevel ()Lorg/gradle/api/provider/Property;
public final fun getReports ()Lorg/gradle/api/NamedDomainObjectContainer;
public abstract fun getReportsDir ()Lorg/gradle/api/file/DirectoryProperty;
public abstract fun getShowProgress ()Lorg/gradle/api/provider/Property;
public abstract fun getShowStackTraces ()Lorg/gradle/api/provider/Property;
public abstract fun getSourceDirs ()Lorg/gradle/api/file/ConfigurableFileCollection;
public abstract fun getSpotbugsClasspath ()Lorg/gradle/api/file/ConfigurableFileCollection;
public abstract fun getUseAuxclasspathFile ()Lorg/gradle/api/provider/Property;
public abstract fun getVisitors ()Lorg/gradle/api/provider/ListProperty;
public abstract fun getWorkerExecutor ()Lorg/gradle/workers/WorkerExecutor;
public final fun init (Lcom/github/spotbugs/snom/SpotBugsExtension;Z)V
public final fun reports (Lorg/gradle/api/Action;)Lorg/gradle/api/NamedDomainObjectContainer;
public final fun run ()V
public final fun setClasses (Lorg/gradle/api/file/FileCollection;)V
public fun setIgnoreFailures (Z)V
}

public final class com/github/spotbugs/snom/internal/SemanticVersion : java/lang/Comparable {
public static final field Companion Lcom/github/spotbugs/snom/internal/SemanticVersion$Companion;
public fun <init> (Ljava/lang/String;)V
public fun compareTo (Lcom/github/spotbugs/snom/internal/SemanticVersion;)I
public synthetic fun compareTo (Ljava/lang/Object;)I
public final fun getMajor ()I
public final fun getMinor ()I
public final fun getPatch ()I
public fun toString ()Ljava/lang/String;
}

public final class com/github/spotbugs/snom/internal/SemanticVersion$Companion {
}

public abstract class com/github/spotbugs/snom/internal/SpotBugsHtmlReport : com/github/spotbugs/snom/SpotBugsReport {
public fun <init> (Lorg/gradle/api/model/ObjectFactory;Lcom/github/spotbugs/snom/SpotBugsTask;)V
public fun getStylesheet ()Lorg/gradle/api/resources/TextResource;
public fun setStylesheet (Ljava/lang/String;)V
public fun setStylesheet (Lorg/gradle/api/resources/TextResource;)V
public fun toCommandLineOption ()Ljava/lang/String;
}

public abstract class com/github/spotbugs/snom/internal/SpotBugsRunner {
public fun <init> ()V
protected final fun buildArguments (Lcom/github/spotbugs/snom/SpotBugsTask;)Ljava/util/List;
protected final fun buildJvmArguments (Lcom/github/spotbugs/snom/SpotBugsTask;)Ljava/util/List;
public abstract fun run (Lcom/github/spotbugs/snom/SpotBugsTask;)V
}

public final class com/github/spotbugs/snom/internal/SpotBugsRunnerForHybrid : com/github/spotbugs/snom/internal/SpotBugsRunner {
public static final field Companion Lcom/github/spotbugs/snom/internal/SpotBugsRunnerForHybrid$Companion;
public fun <init> (Lorg/gradle/workers/WorkerExecutor;Lorg/gradle/api/provider/Property;)V
public fun run (Lcom/github/spotbugs/snom/SpotBugsTask;)V
}

public final class com/github/spotbugs/snom/internal/SpotBugsRunnerForHybrid$Companion {
}

public abstract class com/github/spotbugs/snom/internal/SpotBugsRunnerForHybrid$SpotBugsExecutor : org/gradle/workers/WorkAction {
public fun <init> (Lorg/gradle/process/ExecOperations;)V
public fun execute ()V
}

public abstract interface class com/github/spotbugs/snom/internal/SpotBugsRunnerForHybrid$SpotBugsWorkParameters : org/gradle/workers/WorkParameters {
public abstract fun getArgs ()Lorg/gradle/api/provider/ListProperty;
public abstract fun getClasspath ()Lorg/gradle/api/file/ConfigurableFileCollection;
public abstract fun getIgnoreFailures ()Lorg/gradle/api/provider/Property;
public abstract fun getJavaToolchainExecutablePath ()Lorg/gradle/api/provider/Property;
public abstract fun getJvmArgs ()Lorg/gradle/api/provider/ListProperty;
public abstract fun getMaxHeapSize ()Lorg/gradle/api/provider/Property;
public abstract fun getReports ()Lorg/gradle/api/provider/ListProperty;
public abstract fun getShowStackTraces ()Lorg/gradle/api/provider/Property;
}

public final class com/github/spotbugs/snom/internal/SpotBugsRunnerForJavaExec : com/github/spotbugs/snom/internal/SpotBugsRunner {
Goooler marked this conversation as resolved.
Show resolved Hide resolved
public fun <init> (Lorg/gradle/api/provider/Property;)V
public fun run (Lcom/github/spotbugs/snom/SpotBugsTask;)V
}

public abstract class com/github/spotbugs/snom/internal/SpotBugsSarifReport : com/github/spotbugs/snom/SpotBugsReport {
public fun <init> (Lorg/gradle/api/model/ObjectFactory;Lcom/github/spotbugs/snom/SpotBugsTask;)V
public fun toCommandLineOption ()Ljava/lang/String;
}

public final class com/github/spotbugs/snom/internal/SpotBugsTaskFactory {
public static final field Companion Lcom/github/spotbugs/snom/internal/SpotBugsTaskFactory$Companion;
public fun <init> ()V
public final fun generate (Lorg/gradle/api/Project;)V
}

public final class com/github/spotbugs/snom/internal/SpotBugsTaskFactory$Companion {
public final fun toLowerCamelCase (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String;
}

public abstract class com/github/spotbugs/snom/internal/SpotBugsTextReport : com/github/spotbugs/snom/SpotBugsReport {
public fun <init> (Lorg/gradle/api/model/ObjectFactory;Lcom/github/spotbugs/snom/SpotBugsTask;)V
public fun getDisplayName ()Ljava/lang/String;
public fun toCommandLineOption ()Ljava/lang/String;
}

public abstract class com/github/spotbugs/snom/internal/SpotBugsXmlReport : com/github/spotbugs/snom/SpotBugsReport {
public fun <init> (Lorg/gradle/api/model/ObjectFactory;Lcom/github/spotbugs/snom/SpotBugsTask;)V
public fun getDisplayName ()Ljava/lang/String;
public fun toCommandLineOption ()Ljava/lang/String;
}

1 change: 1 addition & 0 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ plugins {
id("com.github.spotbugs.test")
id("org.sonarqube")
id("io.gitlab.arturbosch.detekt") version "1.23.4"
id("org.jetbrains.kotlinx.binary-compatibility-validator") version "0.13.2"
}

java {
Expand Down