From ae1880f17d2decbd16dbffe55e597c9b4c460782 Mon Sep 17 00:00:00 2001 From: Goooler Date: Mon, 2 Oct 2023 23:07:23 +0800 Subject: [PATCH 1/2] Rename ArtifactoryPluginConvention to ArtifactoryPluginExtension Better alignment with the migration of convention usages. Follow up 1e30e998e13918ed6a571331d073be101e71905f. --- README.md | 4 ++-- .../build.gradle.kts | 4 ++-- .../plugin/artifactory/ArtifactoryPlugin.java | 4 ++-- ...on.java => ArtifactoryPluginExtension.java} | 4 ++-- .../artifactory/dsl/PublisherConfig.java | 2 +- .../ProjectsEvaluatedBuildListener.java | 4 ++-- .../artifactory/task/ArtifactoryTask.java | 4 ++-- .../artifactory/utils/ExtensionsUtils.java | 18 +++++++++--------- 8 files changed, 22 insertions(+), 22 deletions(-) rename src/main/java/org/jfrog/gradle/plugin/artifactory/dsl/{ArtifactoryPluginConvention.java => ArtifactoryPluginExtension.java} (94%) diff --git a/README.md b/README.md index c09acc5..2a6862d 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ make the necessary adjustments based on your platform information: Kotlin Format ```kotlin -configure { +configure { publish { // Define the Artifactory URL for publishing artifacts contextUrl = "http://127.0.0.1:8081/artifactory" @@ -185,7 +185,7 @@ artifacts will be published, and configure other global settings such as Proxy a Kotlin Format ```kotlin -configure { +configure { publish { // Define the Artifactory URL for publishing artifacts contextUrl = "http://127.0.0.1:8081/artifactory" diff --git a/src/functionalTest/resources/gradle-kts-example-publish/build.gradle.kts b/src/functionalTest/resources/gradle-kts-example-publish/build.gradle.kts index 4e7f306..f35da73 100644 --- a/src/functionalTest/resources/gradle-kts-example-publish/build.gradle.kts +++ b/src/functionalTest/resources/gradle-kts-example-publish/build.gradle.kts @@ -1,4 +1,4 @@ -import org.jfrog.gradle.plugin.artifactory.dsl.ArtifactoryPluginConvention +import org.jfrog.gradle.plugin.artifactory.dsl.ArtifactoryPluginExtension import org.jfrog.gradle.plugin.artifactory.task.ArtifactoryTask plugins { @@ -62,7 +62,7 @@ configure(javaProjects()) { } } -configure { +configure { clientConfig.isIncludeEnvVars = true clientConfig.info.addEnvironmentProperty("test.adding.dynVar", java.util.Date().toString()) diff --git a/src/main/java/org/jfrog/gradle/plugin/artifactory/ArtifactoryPlugin.java b/src/main/java/org/jfrog/gradle/plugin/artifactory/ArtifactoryPlugin.java index 5780cd5..65a3843 100644 --- a/src/main/java/org/jfrog/gradle/plugin/artifactory/ArtifactoryPlugin.java +++ b/src/main/java/org/jfrog/gradle/plugin/artifactory/ArtifactoryPlugin.java @@ -5,7 +5,7 @@ import org.gradle.api.logging.Logger; import org.gradle.api.logging.Logging; import org.gradle.api.tasks.TaskProvider; -import org.jfrog.gradle.plugin.artifactory.dsl.ArtifactoryPluginConvention; +import org.jfrog.gradle.plugin.artifactory.dsl.ArtifactoryPluginExtension; import org.jfrog.gradle.plugin.artifactory.listener.ArtifactoryDependencyResolutionListener; import org.jfrog.gradle.plugin.artifactory.listener.ProjectsEvaluatedBuildListener; import org.jfrog.gradle.plugin.artifactory.task.ArtifactoryTask; @@ -26,7 +26,7 @@ public void apply(Project project) { return; } // Get / Add an Artifactory plugin extension to the project module - ArtifactoryPluginConvention extension = ExtensionsUtils.getOrCreateArtifactoryExtension(project); + ArtifactoryPluginExtension extension = ExtensionsUtils.getOrCreateArtifactoryExtension(project); // Add the collect publications for deploy details and extract module-info tasks to the project module TaskProvider collectDeployDetailsTask = TaskUtils.addCollectDeployDetailsTask(project); TaskUtils.addExtractModuleInfoTask(collectDeployDetailsTask, project); diff --git a/src/main/java/org/jfrog/gradle/plugin/artifactory/dsl/ArtifactoryPluginConvention.java b/src/main/java/org/jfrog/gradle/plugin/artifactory/dsl/ArtifactoryPluginExtension.java similarity index 94% rename from src/main/java/org/jfrog/gradle/plugin/artifactory/dsl/ArtifactoryPluginConvention.java rename to src/main/java/org/jfrog/gradle/plugin/artifactory/dsl/ArtifactoryPluginExtension.java index 459de6f..b9d6a8d 100644 --- a/src/main/java/org/jfrog/gradle/plugin/artifactory/dsl/ArtifactoryPluginConvention.java +++ b/src/main/java/org/jfrog/gradle/plugin/artifactory/dsl/ArtifactoryPluginExtension.java @@ -9,7 +9,7 @@ * Main configuration object for the plugin. a DSL object that controls all the plugin configurations. * This object is defined at the user build script ander 'artifactory' closure. */ -public class ArtifactoryPluginConvention { +public class ArtifactoryPluginExtension { private final Project project; @@ -17,7 +17,7 @@ public class ArtifactoryPluginConvention { private PublisherConfig publisherConfig; - public ArtifactoryPluginConvention(Project project) { + public ArtifactoryPluginExtension(Project project) { this.project = project; clientConfig = new ArtifactoryClientConfiguration(new GradleClientLogger(project.getLogger())); } diff --git a/src/main/java/org/jfrog/gradle/plugin/artifactory/dsl/PublisherConfig.java b/src/main/java/org/jfrog/gradle/plugin/artifactory/dsl/PublisherConfig.java index c6ee414..c3153ec 100644 --- a/src/main/java/org/jfrog/gradle/plugin/artifactory/dsl/PublisherConfig.java +++ b/src/main/java/org/jfrog/gradle/plugin/artifactory/dsl/PublisherConfig.java @@ -20,7 +20,7 @@ public class PublisherConfig { Action defaultsAction; @Inject - public PublisherConfig(ObjectFactory objectFactory, ArtifactoryPluginConvention extension) { + public PublisherConfig(ObjectFactory objectFactory, ArtifactoryPluginExtension extension) { this.publisher = extension.getClientConfig().publisher; repository = objectFactory.newInstance(Repository.class, publisher); } diff --git a/src/main/java/org/jfrog/gradle/plugin/artifactory/listener/ProjectsEvaluatedBuildListener.java b/src/main/java/org/jfrog/gradle/plugin/artifactory/listener/ProjectsEvaluatedBuildListener.java index 905b183..745c913 100644 --- a/src/main/java/org/jfrog/gradle/plugin/artifactory/listener/ProjectsEvaluatedBuildListener.java +++ b/src/main/java/org/jfrog/gradle/plugin/artifactory/listener/ProjectsEvaluatedBuildListener.java @@ -10,7 +10,7 @@ import org.gradle.api.publish.PublishingExtension; import org.jfrog.build.extractor.clientConfiguration.ArtifactoryClientConfiguration; import org.jfrog.gradle.plugin.artifactory.Constant; -import org.jfrog.gradle.plugin.artifactory.dsl.ArtifactoryPluginConvention; +import org.jfrog.gradle.plugin.artifactory.dsl.ArtifactoryPluginExtension; import org.jfrog.gradle.plugin.artifactory.task.ArtifactoryTask; import org.jfrog.gradle.plugin.artifactory.utils.ExtensionsUtils; import org.jfrog.gradle.plugin.artifactory.utils.ProjectUtils; @@ -39,7 +39,7 @@ public class ProjectsEvaluatedBuildListener { private void evaluate(ArtifactoryTask collectDeployDetailsTask) { log.debug("Try to evaluate {}", collectDeployDetailsTask); Project project = collectDeployDetailsTask.getProject(); - ArtifactoryPluginConvention extension = ExtensionsUtils.getArtifactoryExtension(project); + ArtifactoryPluginExtension extension = ExtensionsUtils.getArtifactoryExtension(project); if (extension == null) { log.debug("Can't find artifactory extension."); return; diff --git a/src/main/java/org/jfrog/gradle/plugin/artifactory/task/ArtifactoryTask.java b/src/main/java/org/jfrog/gradle/plugin/artifactory/task/ArtifactoryTask.java index 972bfb5..802137b 100644 --- a/src/main/java/org/jfrog/gradle/plugin/artifactory/task/ArtifactoryTask.java +++ b/src/main/java/org/jfrog/gradle/plugin/artifactory/task/ArtifactoryTask.java @@ -22,7 +22,7 @@ import org.jfrog.build.extractor.clientConfiguration.ArtifactSpecs; import org.jfrog.build.extractor.clientConfiguration.ArtifactoryClientConfiguration; import org.jfrog.gradle.plugin.artifactory.Constant; -import org.jfrog.gradle.plugin.artifactory.dsl.ArtifactoryPluginConvention; +import org.jfrog.gradle.plugin.artifactory.dsl.ArtifactoryPluginExtension; import org.jfrog.gradle.plugin.artifactory.dsl.PropertiesConfig; import org.jfrog.gradle.plugin.artifactory.dsl.PublisherConfig; import org.jfrog.gradle.plugin.artifactory.extractor.GradleDeployDetails; @@ -93,7 +93,7 @@ public void evaluateTask() { } } - ArtifactoryPluginConvention extension = ExtensionsUtils.getExtensionWithPublisher(project); + ArtifactoryPluginExtension extension = ExtensionsUtils.getExtensionWithPublisher(project); if (extension == null) { log.debug("Can't find extension configured for {}", getPath()); return; diff --git a/src/main/java/org/jfrog/gradle/plugin/artifactory/utils/ExtensionsUtils.java b/src/main/java/org/jfrog/gradle/plugin/artifactory/utils/ExtensionsUtils.java index 4c01a20..63dc708 100644 --- a/src/main/java/org/jfrog/gradle/plugin/artifactory/utils/ExtensionsUtils.java +++ b/src/main/java/org/jfrog/gradle/plugin/artifactory/utils/ExtensionsUtils.java @@ -8,7 +8,7 @@ import org.jfrog.build.extractor.BuildInfoExtractorUtils; import org.jfrog.build.extractor.clientConfiguration.ArtifactoryClientConfiguration; import org.jfrog.gradle.plugin.artifactory.Constant; -import org.jfrog.gradle.plugin.artifactory.dsl.ArtifactoryPluginConvention; +import org.jfrog.gradle.plugin.artifactory.dsl.ArtifactoryPluginExtension; import java.util.Map; import java.util.Properties; @@ -24,10 +24,10 @@ public class ExtensionsUtils { * @param project - the project to fetch/create its extension * @return project extension */ - public static ArtifactoryPluginConvention getOrCreateArtifactoryExtension(Project project) { - ArtifactoryPluginConvention con = project.getExtensions().findByType(ArtifactoryPluginConvention.class); + public static ArtifactoryPluginExtension getOrCreateArtifactoryExtension(Project project) { + ArtifactoryPluginExtension con = project.getExtensions().findByType(ArtifactoryPluginExtension.class); if (con == null) { - con = project.getExtensions().create(Constant.ARTIFACTORY, ArtifactoryPluginConvention.class, project); + con = project.getExtensions().create(Constant.ARTIFACTORY, ArtifactoryPluginExtension.class, project); } return con; } @@ -38,8 +38,8 @@ public static ArtifactoryPluginConvention getOrCreateArtifactoryExtension(Projec * @param project - the project that will get its root's extension * @return Artifactory's extension defined at the root project if exists */ - public static ArtifactoryPluginConvention getArtifactoryExtension(Project project) { - return project.getRootProject().getExtensions().findByType(ArtifactoryPluginConvention.class); + public static ArtifactoryPluginExtension getArtifactoryExtension(Project project) { + return project.getRootProject().getExtensions().findByType(ArtifactoryPluginExtension.class); } /** @@ -49,9 +49,9 @@ public static ArtifactoryPluginConvention getArtifactoryExtension(Project projec * @param project - the project to fetch its publisher configurations * @return an Artifactory extension with publisher configured or null if not found */ - public static ArtifactoryPluginConvention getExtensionWithPublisher(Project project) { + public static ArtifactoryPluginExtension getExtensionWithPublisher(Project project) { while (project != null) { - ArtifactoryPluginConvention acc = project.getExtensions().findByType(ArtifactoryPluginConvention.class); + ArtifactoryPluginExtension acc = project.getExtensions().findByType(ArtifactoryPluginExtension.class); if (acc != null) { ArtifactoryClientConfiguration.PublisherHandler publisher = acc.getClientConfig().publisher; if (publisher.getContextUrl() != null && (publisher.getRepoKey() != null || publisher.getSnapshotRepoKey() != null)) { @@ -70,7 +70,7 @@ public static ArtifactoryPluginConvention getExtensionWithPublisher(Project proj * @return a configured publisher handler or null if not found */ public static ArtifactoryClientConfiguration.PublisherHandler getPublisherHandler(Project project) { - ArtifactoryPluginConvention extension = getExtensionWithPublisher(project); + ArtifactoryPluginExtension extension = getExtensionWithPublisher(project); if (extension == null) { return null; } From b64aa44958fe52b58484c819514990dd739ed7f2 Mon Sep 17 00:00:00 2001 From: Goooler Date: Tue, 3 Oct 2023 13:51:36 +0800 Subject: [PATCH 2/2] Use artifactory blocks in docs --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2a6862d..75b64b5 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ make the necessary adjustments based on your platform information: Kotlin Format ```kotlin -configure { +artifactory { publish { // Define the Artifactory URL for publishing artifacts contextUrl = "http://127.0.0.1:8081/artifactory" @@ -185,7 +185,7 @@ artifacts will be published, and configure other global settings such as Proxy a Kotlin Format ```kotlin -configure { +artifactory { publish { // Define the Artifactory URL for publishing artifacts contextUrl = "http://127.0.0.1:8081/artifactory"