Add details for gradle custom plugin. by prudhvigodithi · Pull Request #144 · opensearch-project/opensearch-plugins

prudhvigodithi · 2022-04-27T18:16:09Z

Signed-off-by: pgodithi pgodithi@amazon.com

Custom plugin's readme

Description

This PR will add a doc for gradle custom plugins and explains in details on how to use opensearch.pluginzip plugin

Issues Resolved

#143

Associated issues

opensearch-project/opensearch-build#1916

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.

Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com> Custom plugin's readme Signed-off-by: pgodithi <pgodithi@amazon.com>

Signed-off-by: pgodithi <pgodithi@amazon.com>

prudhvigodithi · 2022-04-28T14:04:01Z

Hey @dblock can you please review this PR?
(To better Read)
I will link this doc to the issue's created for each plugin repo as as part of the campaign.
Example the issue will be something like this prudhvigodithi/opensearch-build#18

GRADLE_CUSTOM_PLUGINS.md

Signed-off-by: pgodithi <pgodithi@amazon.com>

prudhvigodithi · 2022-04-28T15:34:12Z

Thanks @gaiksaya, added all your suggestions in the latest commits.

dblock

I think this belongs in "Building Plugins with OpenSearch", ie. BUILDING.md.

I'd also want to see examples implemented in https://github.com/opensearch-project/opensearch-plugin-template-java that match the doc.

prudhvigodithi · 2022-04-28T20:48:36Z

Hey @dblock, you suggest to move the data of GRADLE_CUSTOM_PLUGINS.md(added via this PR) to BUILDING.md?
Also Coming to opensearch-plugin-template-java, this I see for creating any new OpenSearch plugins repo and but not for gradle plugins (under buildSrc/), did I miss anything from you previous comment ?

Signed-off-by: pgodithi <pgodithi@amazon.com>

prudhvigodithi · 2022-04-29T20:42:59Z

Hey @dblock migrated the details to BUILDING.md.
PR for opensearch-plugin-template-java
Once this is merged I will add a new PR for opensearch-plugin-template-java to add details about opensearch.pluginzip

dblock

I mostly have nitpicks, the doc is good!

BUILDING.md

dblock · 2022-05-03T15:15:30Z

BUILDING.md

+[Plugin Code](https://github.com/opensearch-project/OpenSearch/tree/main/buildSrc/src/main/java/org/opensearch/gradle/pluginzip), [Plugin Tests](https://github.com/opensearch-project/OpenSearch/tree/main/buildSrc/src/test/java/org/opensearch/gradle/pluginzip), [Plugin META-INF](https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/src/main/resources/META-INF/gradle-plugins/opensearch.pluginzip.properties)
+
+
+#### Plugin Design


I would remove this title.

Wont it be easy to check the plugin code location, if a user wants to know more details about this ?

The documentation for the plugin belongs with the plugin in its code. You can add these things as comments in the plugin itself. This doc is just about how to use it.

BUILDING.md

dblock · 2022-05-03T15:17:47Z

BUILDING.md

+
+#### Plugin Usage
+
+* The Key requirement for this plugin to work is that the zip should be generated by `bundlePlugin` task that comes from existing [PublishPlugin](https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/src/main/java/org/opensearch/gradle/PublishPlugin.java). 


Make the steps numbered, 1.2.3

@dblock so instead of * you suggest add number ?

It's not an enumeration, I'd just write the text as is without any *.

dblock · 2022-05-03T15:18:32Z

BUILDING.md

+
+    Note: If there is a managed `build.sh` file and do not have any publish tasks, then its not required to exlcude these tasks, only required if it is calling publish tasks that targets ALL repos and ALL publications.
+
+* Quick Example:


Point to a PR instead of lines of code, these links will stop working when those files are edited for whatever reason.

@dblock the plugins have not yet started to use to this gradle plugin, so we dont yet have a PR, once this document is merged and I have a PR as an example, then I can update the doc back again.

README.md

dblock · 2022-05-03T15:19:15Z

BUILDING.md

  - [Include Checksums in Maven Publications](#include-checksums-in-maven-publications)
+  - [Custom Gradle Plugins](#custom-gradle-plugins)
+    - [opensearch.pluginzip](#opensearchpluginzip)
+        - [Plugin Design](#plugin-design)


I would get rid of sub-sections and make it one entry (opensearch.pluginzip).

would it not be easy for a user to read sub-sections rather than a bit fat single section about the plugin? :)

Signed-off-by: pgodithi <pgodithi@amazon.com>

bbarani · 2022-05-06T04:57:55Z

I mostly have nitpicks, the doc is good!

@dblock Can we go ahead and merge this PR and work on the nitpicks later? I would like to see the teams start publishing the plugin zips from 2.0 GA version.

Signed-off-by: pgodithi <pgodithi@amazon.com>

prudhvigodithi · 2022-05-06T18:42:51Z

Hey @dblock I have pushed some suggested NIT's, please review.
Thanks

dblock

This looks good! I would just move the whole plugin design thing out. But also you can iterate on this later.

dblock · 2022-05-06T22:21:28Z

BUILDING.md

+[Plugin Code](https://github.com/opensearch-project/OpenSearch/tree/main/buildSrc/src/main/java/org/opensearch/gradle/pluginzip), [Plugin Tests](https://github.com/opensearch-project/OpenSearch/tree/main/buildSrc/src/test/java/org/opensearch/gradle/pluginzip), [Plugin META-INF](https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/src/main/resources/META-INF/gradle-plugins/opensearch.pluginzip.properties)
+
+
+#### Plugin Design


The documentation for the plugin belongs with the plugin in its code. You can add these things as comments in the plugin itself. This doc is just about how to use it.

dblock · 2022-05-06T22:22:11Z

BUILDING.md

+
+#### Plugin Usage
+
+1. The Key requirement for this plugin to work is that the zip should be generated by `bundlePlugin` task that comes from existing [PublishPlugin](https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/src/main/java/org/opensearch/gradle/PublishPlugin.java). 


Nit: try to shorten things, e.g. "The Key requirement for this plugin to work is that the zip should be generated by bundlePlugin task" is the same as "Ensure that your project uses bundlePlugin".

Fixed this @dblock

Signed-off-by: pgodithi <pgodithi@amazon.com>

prudhvigodithi requested a review from a team April 27, 2022 18:16

prudhvigodithi mentioned this pull request Apr 27, 2022

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

Closed

38 tasks

prudhvigodithi added 4 commits April 27, 2022 11:25

Fix link

2a7bcf2

Signed-off-by: pgodithi <pgodithi@amazon.com>

Fix link

3b77542

Signed-off-by: pgodithi <pgodithi@amazon.com>

Fix link

e43e593

Signed-off-by: pgodithi <pgodithi@amazon.com>

Fix link

c6a23b2

Signed-off-by: pgodithi <pgodithi@amazon.com>

gaiksaya reviewed Apr 28, 2022

View reviewed changes

prudhvigodithi added 2 commits April 28, 2022 08:28

Added user suggestions

b384a51

Signed-off-by: pgodithi <pgodithi@amazon.com>

Added user suggestions

b714204

Signed-off-by: pgodithi <pgodithi@amazon.com>

dblock suggested changes Apr 28, 2022

View reviewed changes

prudhvigodithi added 4 commits April 29, 2022 16:33

Add user suggestions

2d2e3eb

Signed-off-by: pgodithi <pgodithi@amazon.com>

Add user suggestions

5913acd

Signed-off-by: pgodithi <pgodithi@amazon.com>

Add user suggestions

5280111

Signed-off-by: pgodithi <pgodithi@amazon.com>

Add user suggestions

80e8669

Signed-off-by: pgodithi <pgodithi@amazon.com>

prudhvigodithi mentioned this pull request May 3, 2022

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

Merged

dblock suggested changes May 3, 2022

View reviewed changes

prudhvigodithi added 2 commits May 3, 2022 13:47

fixed NIT's

2ebed73

Signed-off-by: pgodithi <pgodithi@amazon.com>

fixed NIT's

7e73079

Signed-off-by: pgodithi <pgodithi@amazon.com>

prudhvigodithi added 2 commits May 6, 2022 09:09

fixed NIT's

dcf35a1

Signed-off-by: pgodithi <pgodithi@amazon.com>

fixed NIT's

41a7861

Signed-off-by: pgodithi <pgodithi@amazon.com>

dblock previously approved these changes May 6, 2022

View reviewed changes

dblock requested a review from gaiksaya May 6, 2022 22:23

fixed Nit's

eb4a724

Signed-off-by: pgodithi <pgodithi@amazon.com>

prudhvigodithi dismissed dblock’s stale review via eb4a724 May 6, 2022 22:29

dblock approved these changes May 6, 2022

View reviewed changes

bbarani approved these changes May 6, 2022

View reviewed changes

dblock merged commit 704764e into opensearch-project:main May 10, 2022

		[Plugin Code](https://github.com/opensearch-project/OpenSearch/tree/main/buildSrc/src/main/java/org/opensearch/gradle/pluginzip), [Plugin Tests](https://github.com/opensearch-project/OpenSearch/tree/main/buildSrc/src/test/java/org/opensearch/gradle/pluginzip), [Plugin META-INF](https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/src/main/resources/META-INF/gradle-plugins/opensearch.pluginzip.properties)


		#### Plugin Design


		#### Plugin Usage

		* The Key requirement for this plugin to work is that the zip should be generated by `bundlePlugin` task that comes from existing [PublishPlugin](https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/src/main/java/org/opensearch/gradle/PublishPlugin.java).


		Note: If there is a managed `build.sh` file and do not have any publish tasks, then its not required to exlcude these tasks, only required if it is calling publish tasks that targets ALL repos and ALL publications.

		* Quick Example:


		#### Plugin Usage

		1. The Key requirement for this plugin to work is that the zip should be generated by `bundlePlugin` task that comes from existing [PublishPlugin](https://github.com/opensearch-project/OpenSearch/blob/main/buildSrc/src/main/java/org/opensearch/gradle/PublishPlugin.java).

Conversation

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

Uh oh!

Description

Issues Resolved

Associated issues

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

prudhvigodithi commented Apr 28, 2022

Uh oh!

dblock left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

prudhvigodithi commented Apr 29, 2022

Uh oh!

dblock left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

prudhvigodithi commented May 6, 2022

Uh oh!

dblock left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

prudhvigodithi commented Apr 27, 2022 •

edited

Loading

prudhvigodithi commented Apr 28, 2022 •

edited

Loading

prudhvigodithi commented Apr 28, 2022 •

edited

Loading

dblock May 6, 2022 •

edited

Loading

bbarani commented May 6, 2022 •

edited

Loading