Allow to configure POM for ZIP publication by reta · Pull Request #3252 · opensearch-project/OpenSearch

reta · 2022-05-09T14:45:41Z

Signed-off-by: Andriy Redko andriy.redko@aiven.io

Description

Allow to configure POM for ZIP publication using DSL

publishing {
    publications {
        pluginZip(MavenPublication) { publication ->
            pom {
              name = pluginName
              description = pluginDescription
              licenses {
                license {
                  name = "The Apache License, Version 2.0"
                  url = "http://www.apache.org/licenses/LICENSE-2.0.txt"
                }
              }
              developers {
                developer {
                  name = "OpenSearch"
                  url = "https://github.com/opensearch-project/opensearch-plugin-template-java"
                }
              }
            }
        }
    }
}

Issues Resolved

Related to opensearch-project/opensearch-plugin-template-java#31

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

reta · 2022-05-09T14:46:21Z

@dblock @prudhvigodithi could you folks please take a look?

opensearch-ci-bot · 2022-05-09T15:20:00Z

✅ Gradle Check success a64bf2be45c203668557721b84c61f2978f3f22f
Log 5161

Reports 5161

opensearch-ci-bot · 2022-05-09T18:53:30Z

✅ Gradle Check success 4402e7772f8ec08e360e2855bb50f9697d66cf80
Log 5174

Reports 5174

prudhvigodithi · 2022-05-09T23:36:20Z

Hey @reta please check this comment added on opensearch-plugin-template-java PR.
Thank you

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

reta · 2022-05-10T13:49:25Z

@prudhvigodithi I think we are getting there - clean and concise way to customize plugin's ZIP POM file:

publishing {
    publications {
        pluginZip(MavenPublication) { publication ->
            pom {
              name = pluginName
              description = pluginDescription
              licenses {
                license {
                  name = "The Apache License, Version 2.0"
                  url = "http://www.apache.org/licenses/LICENSE-2.0.txt"
                }
              }
              developers {
                developer {
                  name = "OpenSearch"
                  url = "https://github.com/opensearch-project/opensearch-plugin-template-java"
                }
              }
            }
        }
    }
}

prudhvigodithi · 2022-05-10T14:16:38Z

Hey @reta, looks to me this neat, but this is only for zip's right, for jars, users need to declare it separately again? if so it should be fine as well, as we might need to isolate the pom fields for both, in future we might have unique fields per publication.

opensearch-ci-bot · 2022-05-10T14:17:36Z

✅ Gradle Check success 7720ae0
Log 5195

Reports 5195

prudhvigodithi · 2022-05-10T14:17:38Z

buildSrc/src/main/java/org/opensearch/gradle/pluginzip/Publish.java

+                        mavenZip.setArtifactId(zipArtifact);
+                        mavenZip.setVersion(zipVersion);
+                    });
+                } else {


@reta we need this if/else condition so that user can declare a publication of pluginZip and pom fields ?

prudhvigodithi · 2022-05-10T14:21:37Z

buildSrc/src/main/java/org/opensearch/gradle/pluginzip/Publish.java

            }
            Task publishPluginZipPublicationToZipStagingRepository = project.getTasks()
                .findByName("publishPluginZipPublicationToZipStagingRepository");
-            if (validatePluginZipPom != null) {


we might still need this @reta
The reason I have added this because I got the following warning
Error:

> Task :validatePluginZipPom Execution optimizations have been disabled for task ':validatePluginZipPom' to ensure correctness due to the following reasons: - Gradle detected a problem with the following location: '/usr/share/opensearch/git/opensearch-plugin-template-java/build/distributions/rename-unspecified.pom'. Reason: Task ':validatePluginZipPom' uses this output of task ':generatePomFileForNebulaPublication' without declaring an explicit or implicit dependency. This can lead to incorrect results being produced, depending on what order the tasks are executed. Please refer to https://docs.gradle.org/7.4.2/userguide/validation_problems.html#implicit_dependency for more details about this problem.

The validatePluginZipPom is above, I did not touch it: https://github.com/opensearch-project/OpenSearch/pull/3252/files/7720ae0d0412a97b77d1077be08cca6a95eedecf#diff-2a5851da2408bbeb8733433421917f253614fffe49449da0dd315a15ed8cdf74R80

This condition should be for publishPluginZipPublicationToZipStagingRepository, not validatePluginZipPom

lol my bad, this formatting looks like it was removed, yes I can see those 2 conditions are not touched.

reta · 2022-05-10T14:46:46Z

Hey @reta, looks to me this neat, but this is only for zip's right, for jars, users need to declare it separately again? if so it should be fine as well, as we might need to isolate the pom fields for both, in future we might have unique fields per publication.

Correct, this is per publication

prudhvigodithi · 2022-05-10T15:10:00Z

Hey @reta
I get the following error when tested with these new changes
Cannot add a Publication with name 'pluginZip' as a Publication with that name already exists.
build.gradle

reta · 2022-05-10T15:14:58Z

Hey @reta I get the following error when tested with these new changes Cannot add a Publication with name 'pluginZip' as a Publication with that name already exists. build.gradle

@prudhvigodithi I assume you pulled this pull request, republished local artifacts and used 3.0.0-SNAPSHOT version for opensearch (unless you cherry-picked the change to another branch), right?

./gradlew clean test publishPluginZipPublicationToZipStagingRepository

BUILD SUCCESSFUL in 16s

prudhvigodithi · 2022-05-10T15:49:06Z

Hey @reta I get the following error when tested with these new changes Cannot add a Publication with name 'pluginZip' as a Publication with that name already exists. build.gradle

@prudhvigodithi I assume you pulled this pull request, republished local artifacts and used 3.0.0-SNAPSHOT version for opensearch (unless you cherry-picked the change to another branch), right?
./gradlew clean test publishPluginZipPublicationToZipStagingRepository

BUILD SUCCESSFUL in 16s   

Hey @reta i'm testing with actual plugin, above seems to my local gradle cache issue, but still I get another error as

2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] 
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] FAILURE: Build failed with an exception.
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] 
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] * What went wrong:
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] Execution failed for task ':publishPluginZipPublicationToZipStagingRepository'.
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] > Failed to publish publication 'pluginZip' to repository 'zipStaging'
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter]    > Invalid publication 'pluginZip': POM file is invalid. Check any modifications you have made to the POM file.

job-scheduler build.gradle

reta · 2022-05-10T16:03:33Z

Hey @reta I get the following error when tested with these new changes Cannot add a Publication with name 'pluginZip' as a Publication with that name already exists. build.gradle

@prudhvigodithi I assume you pulled this pull request, republished local artifacts and used 3.0.0-SNAPSHOT version for opensearch (unless you cherry-picked the change to another branch), right?
./gradlew clean test publishPluginZipPublicationToZipStagingRepository

BUILD SUCCESSFUL in 16s   
Hey @reta i'm testing with actual plugin, above seems to my local gradle cache issue, but still I get another error as
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] 
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] FAILURE: Build failed with an exception.
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] 
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] * What went wrong:
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] Execution failed for task ':publishPluginZipPublicationToZipStagingRepository'.
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] > Failed to publish publication 'pluginZip' to repository 'zipStaging'
2022-05-10T15:43:57.932+0000 [ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter]    > Invalid publication 'pluginZip': POM file is invalid. Check any modifications you have made to the POM file.
job-scheduler build.gradle

@prudhvigodithi sorry, I have difficulties to follow what you are doing, these are the changes I did https://github.com/opensearch-project/job-scheduler/compare/main...reta:publishzip?expand=1

prudhvigodithi · 2022-05-10T16:09:56Z

@reta now I get this, why testing fails, as allProjects settings overrides the declared publishing settings, hence failed to append license and developer fields, once merged I might need to add this point to the document.

prudhvigodithi · 2022-05-10T16:11:48Z

Once merged, I will update the existing opensearch-plugin-template-java PR https://github.com/opensearch-project/opensearch-plugin-template-java/pull/31/files with new POM declaration format.
@dblock @bbarani

Signed-off-by: Andriy Redko <andriy.redko@aiven.io> (cherry picked from commit f5c0b30)

dblock · 2022-05-10T17:06:20Z

Please update https://github.com/opensearch-project/opensearch-plugins/blob/main/BUILDING.md#custom-gradle-plugins too!

Signed-off-by: Andriy Redko <andriy.redko@aiven.io> (cherry picked from commit f5c0b30) Co-authored-by: Andriy Redko <andriy.redko@aiven.io>

prudhvigodithi · 2022-05-10T17:22:10Z

Please update https://github.com/opensearch-project/opensearch-plugins/blob/main/BUILDING.md#custom-gradle-plugins too!

Created a PR @dblock opensearch-project/opensearch-plugins#149, please check.

reta requested a review from a team as a code owner May 9, 2022 14:45

reta mentioned this pull request May 9, 2022

Added opensearch.pluginzip plugin opensearch-project/opensearch-plugin-template-java#31

Merged

reta added backport 2.x Backport to 2.x branch backport 2.0 Backport to 2.0 branch labels May 9, 2022

reta force-pushed the fixing.pom branch from a64bf2b to 4402e77 Compare May 9, 2022 18:09

kartg approved these changes May 9, 2022

View reviewed changes

Allow to configure POM for ZIP publication

7720ae0

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

reta force-pushed the fixing.pom branch from 4402e77 to 7720ae0 Compare May 10, 2022 13:47

reta changed the title ~~Generating POM for ZIP publication using project.ext properties~~ Allow to configure POM for ZIP publication May 10, 2022

prudhvigodithi reviewed May 10, 2022

View reviewed changes

prudhvigodithi approved these changes May 10, 2022

View reviewed changes

reta merged commit f5c0b30 into opensearch-project:main May 10, 2022

opensearch-trigger-bot bot pushed a commit that referenced this pull request May 10, 2022

Allow to configure POM for ZIP publication (#3252)

2d47801

Signed-off-by: Andriy Redko <andriy.redko@aiven.io> (cherry picked from commit f5c0b30)

opensearch-trigger-bot bot mentioned this pull request May 10, 2022

[Backport 2.x] Allow to configure POM for ZIP publication #3270

Merged

opensearch-trigger-bot bot pushed a commit that referenced this pull request May 10, 2022

Allow to configure POM for ZIP publication (#3252)

0d6db48

Signed-off-by: Andriy Redko <andriy.redko@aiven.io> (cherry picked from commit f5c0b30)

opensearch-trigger-bot bot mentioned this pull request May 10, 2022

[Backport 2.0] Allow to configure POM for ZIP publication #3271

Merged

dblock pushed a commit that referenced this pull request May 10, 2022

Allow to configure POM for ZIP publication (#3252) (#3270)

a6913e0

Signed-off-by: Andriy Redko <andriy.redko@aiven.io> (cherry picked from commit f5c0b30) Co-authored-by: Andriy Redko <andriy.redko@aiven.io>

dblock pushed a commit that referenced this pull request May 10, 2022

Allow to configure POM for ZIP publication (#3252) (#3271)

92d8b8f

Signed-off-by: Andriy Redko <andriy.redko@aiven.io> (cherry picked from commit f5c0b30) Co-authored-by: Andriy Redko <andriy.redko@aiven.io>

prudhvigodithi mentioned this pull request May 10, 2022

Updated readme: Pass custom POM extensions to zip publication: opensearch-project/opensearch-plugins#149

Merged

prudhvigodithi mentioned this pull request May 10, 2022

[Meta] Mechanism to publish the plugin zips to maven repo. opensearch-project/opensearch-build#1916

Closed

38 tasks

lukas-vlcek mentioned this pull request Jun 22, 2022

[BUG] Custom POM configuration for ZIP publication produces duplicit tags (url, scm) #3649

Closed

Conversation

reta commented May 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Check List

Uh oh!

reta commented May 9, 2022

Uh oh!

opensearch-ci-bot commented May 9, 2022

Uh oh!

opensearch-ci-bot commented May 9, 2022

Uh oh!

prudhvigodithi commented May 9, 2022

Uh oh!

reta commented May 10, 2022

Uh oh!

prudhvigodithi commented May 10, 2022

Uh oh!

opensearch-ci-bot commented May 10, 2022

Uh oh!

prudhvigodithi May 10, 2022

Choose a reason for hiding this comment

Uh oh!

reta May 10, 2022

Choose a reason for hiding this comment

Uh oh!

prudhvigodithi May 10, 2022

Choose a reason for hiding this comment

Uh oh!

reta May 10, 2022

Choose a reason for hiding this comment

Uh oh!

prudhvigodithi May 10, 2022

Choose a reason for hiding this comment

Uh oh!

reta commented May 10, 2022

Uh oh!

prudhvigodithi commented May 10, 2022

Uh oh!

reta commented May 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

prudhvigodithi commented May 10, 2022

Uh oh!

reta commented May 10, 2022

Uh oh!

prudhvigodithi commented May 10, 2022

Uh oh!

prudhvigodithi commented May 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dblock commented May 10, 2022

Uh oh!

prudhvigodithi commented May 10, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

reta commented May 9, 2022 •

edited

Loading

reta commented May 10, 2022 •

edited

Loading

prudhvigodithi commented May 10, 2022 •

edited

Loading