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

Improve opensearch.pluginzip docs. #153

Merged
merged 7 commits into from
Jun 27, 2022

Conversation

prudhvigodithi
Copy link
Contributor

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

Description

Improve opensearch.pluginzip docs, to add more details, purpose and boundaries of usage.

Issues Resolved

opensearch-project/OpenSearch#3692

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>
@prudhvigodithi prudhvigodithi requested a review from a team June 26, 2022 15:31
Signed-off-by: pgodithi <pgodithi@amazon.com>
Signed-off-by: pgodithi <pgodithi@amazon.com>
Signed-off-by: pgodithi <pgodithi@amazon.com>
Signed-off-by: pgodithi <pgodithi@amazon.com>
BUILDING.md Outdated Show resolved Hide resolved
BUILDING.md Outdated Show resolved Hide resolved
BUILDING.md Outdated Show resolved Hide resolved
BUILDING.md Outdated Show resolved Hide resolved
BUILDING.md Outdated Show resolved Hide resolved
Signed-off-by: pgodithi <pgodithi@amazon.com>
@prudhvigodithi
Copy link
Contributor Author

Hey @reta pushed the latest commit with your suggested changes.
Thank you

reta
reta previously approved these changes Jun 27, 2022
gaiksaya
gaiksaya previously approved these changes Jun 27, 2022
BUILDING.md Outdated
```./gradlew publishPluginZipPublicationToZipStagingRepository -Dopensearch.version=$VERSION -Dbuild.snapshot=$SNAPSHOT -Dbuild.version_qualifier=$QUALIFIER```

Note: The gradle assemble task `./gradlew assemble` should be called first before calling `publishPluginZipPublicationToZipStagingRepository`, as zip file need to be generated first before publishing.
Note: The gradle assemble task `./gradlew assemble` should be called first before calling `publishPluginZipPublicationToZipStagingRepository`, as zip file need to be generated before publishing.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if plugins support ./gradle assemble, i know few plugins use ./gradle build[1]

[1] https://github.com/opensearch-project/anomaly-detection/blob/main/DEVELOPER_GUIDE.md#building-from-the-command-line

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AD plugin does support ./gradlew assemble

Copy link
Contributor Author

@prudhvigodithi prudhvigodithi Jun 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the inputs @saratvemulapalli and @ylwu-amzn, the idea to mention the zip has be available (either by calling assemble or build) before publishing, let me rephrase the following way and let me know if this is good to go with.

Note: The gradle task responsible to generate the distribution zip should be called first before executing publishPluginZipPublicationToZipStagingRepository, as the zip file needs to be generated before publishing.

Copy link
Contributor Author

@prudhvigodithi prudhvigodithi Jun 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed the change in my latest commit.
@saratvemulapalli @ylwu-amzn

Signed-off-by: pgodithi <pgodithi@amazon.com>
@saratvemulapalli saratvemulapalli added the documentation Improvements or additions to documentation label Jun 27, 2022
@saratvemulapalli saratvemulapalli merged commit 9ef83a9 into opensearch-project:main Jun 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants