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
Document how to test a dev version of a 3party dependency #78962
Document how to test a dev version of a 3party dependency #78962
Conversation
- Introduce a FAQ section to BUILDING.MD - Provide three solutions to test and use a custom third party dependency in our elasticsearch build
Pinging @elastic/es-delivery (Team:Delivery) |
BUILDING.md
Outdated
flat directory repositories cannot be used to override artifacts with real meta-data from other repositories declared in the build. | ||
For example, if Gradle finds only `jmxri-1.2.1.jar` in a flat directory repository, but `jmxri-1.2.1.pom` in another repository | ||
that supports meta-data, it will use the second repository to provide the module. | ||
For the use case of overriding remote artifacts with local ones consider using an Ivy or Maven repository instead whose URL points to a local directory. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to give an example of this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tweaked the recommendation to use a version that is not public available yet. Setting up a manual ivy or maven repository would likely involve handcraft a custom ivy.xml or pom.xml file which is not recommended and likely causes more trouble :)
Co-authored-by: Rory Hunter <pugnascotia@users.noreply.github.com>
Co-authored-by: Rory Hunter <pugnascotia@users.noreply.github.com>
Apply review feedback
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One comment, otherwise LGTM.
BUILDING.md
Outdated
} | ||
``` | ||
|
||
3. Update the dependency declaration of the artifact in question to match the custom build version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we clarify here what that means? When using a flatDir repo the dependency notation is simply the jar name isn't it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added some more details about that
) * Document how to test a dev version of a 3party dependency - Introduce a FAQ section to BUILDING.MD - Provide three solutions to test and use a custom third party dependency in our elasticsearch build * Fix jitpack repo declaration * Tweak formatting * Apply review feedback Co-authored-by: Rory Hunter <pugnascotia@users.noreply.github.com> * Apply further review feedback Co-authored-by: Rory Hunter <pugnascotia@users.noreply.github.com> * Tweak recommendations for replacing a dependency Apply review feedback * Elaborate on dependency declaration to resolves jars from flat dir repositories Co-authored-by: Rory Hunter <pugnascotia@users.noreply.github.com>
💚 Backport successful
|
…79040) * Document how to test a dev version of a 3party dependency - Introduce a FAQ section to BUILDING.MD - Provide three solutions to test and use a custom third party dependency in our elasticsearch build * Fix jitpack repo declaration * Tweak formatting * Apply review feedback Co-authored-by: Rory Hunter <pugnascotia@users.noreply.github.com> * Apply further review feedback Co-authored-by: Rory Hunter <pugnascotia@users.noreply.github.com> * Tweak recommendations for replacing a dependency Apply review feedback * Elaborate on dependency declaration to resolves jars from flat dir repositories Co-authored-by: Rory Hunter <pugnascotia@users.noreply.github.com> Co-authored-by: Rory Hunter <pugnascotia@users.noreply.github.com>
in our elasticsearch build