Remove outdated optional transitive recommended pdep restriction (#1756)

palantir · Jan 9, 2025 · 06bc942 · 06bc942
1 parent 1666c0a
commit 06bc942
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 50 deletions.
diff --git a/changelog/@unreleased/pr-1756.v2.yml b/changelog/@unreleased/pr-1756.v2.yml
@@ -0,0 +1,5 @@
+type: improvement
+improvement:
+  description: Remove outdated optional transitive recommended pdep restriction
+  links:
+  - https://github.com/palantir/sls-packaging/pull/1756
diff --git a/...ncies/src/main/java/com/palantir/gradle/dist/RecommendedProductDependenciesExtension.java b/...ncies/src/main/java/com/palantir/gradle/dist/RecommendedProductDependenciesExtension.java
@@ -42,12 +42,6 @@ public final void productDependency(@DelegatesTo(ProductDependency.class) Closur
         recommendedProductDependencies.add(providerFactory.provider(() -> {
             ProductDependency dep = new ProductDependency();
             project.configure(dep, closure);
-            if (dep.getOptional()) {
-                throw new IllegalArgumentException(String.format(
-                        "Optional dependencies are not supported for recommended product "
-                                + "dependencies. Please remove optional for dependency %s",
-                        dep));
-            }
             dep.isValid();
             return dep;
         }));

diff --git a/...c/test/groovy/com/palantir/gradle/dist/RecommendedProductDependenciesExtensionTest.groovy b/...c/test/groovy/com/palantir/gradle/dist/RecommendedProductDependenciesExtensionTest.groovy
diff --git a/...roovy/com/palantir/gradle/dist/RecommendedProductDependenciesPluginIntegrationSpec.groovy b/...roovy/com/palantir/gradle/dist/RecommendedProductDependenciesPluginIntegrationSpec.groovy
@@ -45,6 +45,7 @@ class RecommendedProductDependenciesPluginIntegrationSpec extends IntegrationSpe
                 minimumVersion = '1.0.0'
                 maximumVersion = '1.x.x'
                 recommendedVersion = '1.2.3'
+                optional = true
             }
         }
         """.stripIndent()
@@ -62,6 +63,7 @@ class RecommendedProductDependenciesPluginIntegrationSpec extends IntegrationSpe
         dep.minimumVersion == "1.0.0"
         dep.maximumVersion == "1.x.x"
         dep.recommendedVersion == "1.2.3"
+        dep.optional
     }
 
     def 'Jar includes recommended product dependencies'() {

diff --git a/readme.md b/readme.md
@@ -424,14 +424,13 @@ recommendedProductDependencies {
         minimumVersion = rootProject.version
         maximumVersion = "${rootProject.version.tokenize('.')[0].toInteger()}.x.x"
         recommendedVersion = rootProject.version
+        optional = true
     }
 }
 ```
 
 The recommended product dependencies will be serialized into the jar manifest of the jar that the project produces. The SLS distribution and asset plugins will inspect the manifest of all jars in the server or asset and extract the recommended product dependencies.
 
-Marking a product dependency as optional in recommendedProductDependencies [is not currently supported](https://github.com/palantir/sls-packaging/issues/1208).
-
 ## License
 
 This plugin is made available under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).