Add support for publishing maven-metadata.xml #1260
+308
−17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Maven repositories normally have a maven-metadata.xml file that indicate to the Maven
system what versions are available and which is to be considered the latest version.
```xml
<metadata modelVersion="1.1.0">
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<versioning>
<latest>1.0</latest>
<release>1.0</release>
<versions>
<version>1.0</version>
</versions>
<lastUpdated>20200731090423</lastUpdated>
</versioning>
</metadata>
```
At Confluent, we use AWS Code Artifactory which does not mark a Maven package as "published" unless
a new maven-metadata.xml is uploaded indicating so.
* Add support for reading existing maven-metadata.xml
* Add support for adding the new version to the metadata object
* Add support to upload the file for http & file protocols
* Add small test cases to validate SerDe for Maven metadata object from XML
Co-authored-by: Vince Rose <[email protected]>
Co-authored-by: Na Lou <[email protected]>
|
@shs96c we added a flag to keep it backwards compatible, but we are of the opinion the default should be true. |
fzakaria
commented
Oct 3, 2024
There was a problem hiding this comment.
We tested this locally using:
bazel run //tests/integration/pom_file:pom-example-with-runtime-dep.publish --define "maven_repo=file:///tmp/.m2"
(Note: we had to have set the publish_maven_metadata attr for the target)
Internally at Confluent, we tested the publishing via HTTP to AWS Code Artifactory as well.
| ByteArrayOutputStream os = new ByteArrayOutputStream(); | ||
| new MetadataXpp3Writer().write(os, metadata); | ||
| Files.write(newMavenMetadataXml, os.toByteArray()); | ||
| return upload(mavenMetadataUrl, credentials, newMavenMetadataXml); |
There was a problem hiding this comment.
nit: upload could probably take InputStream but I didn't want to change too much of the code;
Open to doing another pass after on this file if you are open to it.
| * Attempts to download the file at the given targetUrl. | ||
| * Valid protocols are: http(s) & file at the moment. | ||
| */ | ||
| private static CompletableFuture<Optional<String>> download( |
There was a problem hiding this comment.
nit: could move this to a separate file Downloaders to keep this file a bit smaller.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Maven repositories normally have a maven-metadata.xml file that indicate to the Maven system what versions are available and which is to be considered the latest version.
At Confluent, we use AWS Code Artifactory which does not mark a Maven package as "published" unless a new maven-metadata.xml is uploaded indicating so.
Co-authored-by: Vince Rose [email protected]
Co-authored-by: Na Lou [email protected]