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.

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

Mark constructions/functions for Gradle managed types as internal #29

Merged
merged 1 commit into from
Jul 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 0 additions & 8 deletions api/dev-publish-plugin.api
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ public final class dev/adamko/gradle/dev_publish/DevPublishPlugin : org/gradle/a
public static final field DEV_PUB__PUBLICATION_DEPENDENCIES Ljava/lang/String;
public static final field DEV_PUB__PUBLICATION_INCOMING Ljava/lang/String;
public static final field DEV_PUB__PUBLICATION_OUTGOING Ljava/lang/String;
public fun <init> (Lorg/gradle/api/provider/ProviderFactory;Lorg/gradle/api/file/ProjectLayout;Lorg/gradle/api/file/FileSystemOperations;Lorg/gradle/api/model/ObjectFactory;)V
public synthetic fun apply (Ljava/lang/Object;)V
public fun apply (Lorg/gradle/api/Project;)V
}
Expand All @@ -20,12 +19,10 @@ public final class dev/adamko/gradle/dev_publish/DevPublishPlugin$configureMaven
}

public abstract class dev/adamko/gradle/dev_publish/DevPublishPluginExtension {
public fun <init> ()V
public abstract fun getDevMavenRepo ()Lorg/gradle/api/file/DirectoryProperty;
}

public abstract class dev/adamko/gradle/dev_publish/data/PublicationData : org/gradle/api/Named {
public fun <init> (Ljava/lang/String;)V
public abstract fun getArtifacts ()Lorg/gradle/api/file/ConfigurableFileCollection;
public abstract fun getIdentifier ()Lorg/gradle/api/provider/Property;
public fun getName ()Ljava/lang/String;
Expand All @@ -37,7 +34,6 @@ public abstract interface annotation class dev/adamko/gradle/dev_publish/interna
public abstract class dev/adamko/gradle/dev_publish/tasks/BaseDevPublishTask : org/gradle/api/DefaultTask {
public static final field Companion Ldev/adamko/gradle/dev_publish/tasks/BaseDevPublishTask$Companion;
public static final field TASK_GROUP Ljava/lang/String;
public fun <init> ()V
}

public final class dev/adamko/gradle/dev_publish/tasks/BaseDevPublishTask$Companion {
Expand All @@ -49,18 +45,14 @@ public final class dev/adamko/gradle/dev_publish/tasks/DevPublishTasksContainer$
}

public abstract class dev/adamko/gradle/dev_publish/tasks/GeneratePublicationDataChecksumTask : dev/adamko/gradle/dev_publish/tasks/BaseDevPublishTask {
public fun <init> (Lorg/gradle/api/file/FileSystemOperations;)V
public final fun generate ()V
public abstract fun getOutputDirectory ()Lorg/gradle/api/file/DirectoryProperty;
public abstract fun getPublicationData ()Lorg/gradle/api/NamedDomainObjectContainer;
}

public abstract class dev/adamko/gradle/dev_publish/tasks/UpdateDevRepoTask : dev/adamko/gradle/dev_publish/tasks/BaseDevPublishTask {
public fun <init> (Lorg/gradle/api/file/FileSystemOperations;)V
public fun from (Lorg/gradle/api/provider/Provider;)V
public abstract fun getDevRepo ()Lorg/gradle/api/file/DirectoryProperty;
public abstract fun getPublicationsStore ()Lorg/gradle/api/file/DirectoryProperty;
public abstract fun getRepositoryContents ()Lorg/gradle/api/file/ConfigurableFileCollection;
public final fun updateDevRepo ()V
}

10 changes: 7 additions & 3 deletions src/main/kotlin/DevPublishPlugin.kt
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
package dev.adamko.gradle.dev_publish

import dev.adamko.gradle.dev_publish.data.DevPubConfigurationsContainer.Companion.newDevPubConfigurationsContainer
import dev.adamko.gradle.dev_publish.internal.DevPublishInternalApi
import dev.adamko.gradle.dev_publish.services.DevPublishService
import dev.adamko.gradle.dev_publish.services.DevPublishService.Companion.SERVICE_NAME
import dev.adamko.gradle.dev_publish.tasks.DevPublishTasksContainer
import dev.adamko.gradle.dev_publish.utils.checksumsToDebugString
import java.io.File
import javax.inject.Inject
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.file.FileSystemOperations
Expand All @@ -21,8 +24,6 @@ import org.gradle.api.services.BuildServiceRegistry
import org.gradle.kotlin.dsl.*
import org.gradle.language.base.plugins.LifecycleBasePlugin
import org.gradle.language.base.plugins.LifecycleBasePlugin.CHECK_TASK_NAME
import java.io.File
import javax.inject.Inject

/**
* Utility plugin for publishing subprojects to a local file-based Maven repository.
Expand All @@ -33,7 +34,10 @@ import javax.inject.Inject
*
* This is useful for testing, as Maven metadata and Plugin Marker artifact gets published correctly.
*/
class DevPublishPlugin @Inject constructor(
class DevPublishPlugin
@Inject
@DevPublishInternalApi
constructor(
private val providers: ProviderFactory,
private val layout: ProjectLayout,
private val fs: FileSystemOperations,
Expand Down
3 changes: 2 additions & 1 deletion src/main/kotlin/DevPublishPluginExtension.kt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import org.gradle.api.file.DirectoryProperty
/**
* Settings for controlling the behaviour of [DevPublishPlugin] and tasks.
*/
abstract class DevPublishPluginExtension {
abstract class DevPublishPluginExtension
@DevPublishInternalApi constructor() {

/**
* Location of the file-based test Maven repository.
Expand Down
6 changes: 5 additions & 1 deletion src/main/kotlin/data/PublicationData.kt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package dev.adamko.gradle.dev_publish.data

import dev.adamko.gradle.dev_publish.internal.DevPublishInternalApi
import dev.adamko.gradle.dev_publish.utils.FileChecksumSeparator
import dev.adamko.gradle.dev_publish.utils.checksum
import javax.inject.Inject
Expand All @@ -18,7 +19,10 @@ import org.gradle.api.tasks.PathSensitivity.RELATIVE
*
* @param[named] must match the publication name, [MavenPublication.getName]
*/
abstract class PublicationData @Inject constructor(
abstract class PublicationData
@Inject
@DevPublishInternalApi
constructor(
private val named: String
) : Named {

Expand Down
4 changes: 3 additions & 1 deletion src/main/kotlin/tasks/BaseDevPublishTask.kt
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
package dev.adamko.gradle.dev_publish.tasks

import dev.adamko.gradle.dev_publish.internal.DevPublishInternalApi
import org.gradle.api.DefaultTask
import org.gradle.work.DisableCachingByDefault

/** Base task type for all [dev.adamko.gradle.dev_publish.DevPublishPlugin] tasks. */
@DisableCachingByDefault
abstract class BaseDevPublishTask : DefaultTask() {
abstract class BaseDevPublishTask
@DevPublishInternalApi constructor() : DefaultTask() {
init {
group = TASK_GROUP
}
Expand Down
2 changes: 2 additions & 0 deletions src/main/kotlin/tasks/GeneratePublicationDataChecksumTask.kt
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import javax.inject.Inject
@DisableCachingByDefault
abstract class GeneratePublicationDataChecksumTask
@Inject
@DevPublishInternalApi
constructor(
private val files: FileSystemOperations,
) : BaseDevPublishTask() {
Expand All @@ -36,6 +37,7 @@ constructor(
private val rootDir = project.rootDir

@TaskAction
@DevPublishInternalApi
fun generate() {
files.delete { delete(tempDir) }

Expand Down
2 changes: 2 additions & 0 deletions src/main/kotlin/tasks/UpdateDevRepoTask.kt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import javax.inject.Inject
@CacheableTask
abstract class UpdateDevRepoTask
@Inject
@DevPublishInternalApi
constructor(
private val fs: FileSystemOperations,
) : BaseDevPublishTask() {
Expand Down Expand Up @@ -60,6 +61,7 @@ constructor(
}

@TaskAction
@DevPublishInternalApi
fun updateDevRepo() {
fs.sync {
from(publicationsStore) {
Expand Down
Loading