How to import multi-module maven project from local .m2 repository? | Java Community | Help. Code. Learn. | Page 1

fathom trout May 18, 2024, 1:55 PM

#

Hey 👋

I'm currently working on https://github.com/catppuccin/java which has recently been refactored to be a multi-module maven project, details are as follows:

catppuccin-java: parent pom/module (v2.0.0)
catppuccin-palette: child module (v2.0.0)
catppuccin-processing: child module (v.1.0.0)

Building and packaging this results in a success, as shown below:

[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO] 
[INFO] catppuccin-java 2.0.0 .............................. SUCCESS [  0.720 s]
[INFO] catppuccin-processing 1.0.0 ........................ SUCCESS [  1.952 s]
[INFO] catppuccin-palette 2.0.0 ........................... SUCCESS [  1.814 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  4.956 s
[INFO] Finished at: 2024-05-18T14:42:00+01:00
[INFO] ------------------------------------------------------------------------

Before publishing to maven central, I wanted to make sure that it could be imported into another project, so I ran ./mvnw clean install -U and it resulted in a success, the following files are now present in my local .m2 repository:

┌ repository/com/catppuccin  󱃾 default/vikunja
└ $ tree -L 3
.
├── catppuccin-java
│   ├── 2.0.0
│   │   ├── catppuccin-java-2.0.0.pom
│   │   ├── catppuccin-java-2.0.0.pom.asc
│   │   └── _remote.repositories
│   └── maven-metadata-local.xml
├── catppuccin-palette
│   ├── 2.0.0
│   │   ├── catppuccin-palette-2.0.0.jar
│   │   ├── catppuccin-palette-2.0.0.jar.asc
│   │   ├── catppuccin-palette-2.0.0-javadoc.jar
│   │   ├── catppuccin-palette-2.0.0-javadoc.jar.asc
│   │   ├── catppuccin-palette-2.0.0.pom
│   │   ├── catppuccin-palette-2.0.0.pom.asc
│   │   ├── catppuccin-palette-2.0.0-sources.jar
│   │   ├── catppuccin-palette-2.0.0-sources.jar.asc
│   │   └── _remote.repositories
│   └── maven-metadata-local.xml
└── catppuccin-processing
    ├── 1.0.0
    │   ├── catppuccin-processing-1.0.0.jar
    │   ├── catppuccin-processing-1.0.0.jar.asc
    │   ├── catppuccin-processing-1.0.0-javadoc.jar
    │   ├── catppuccin-processing-1.0.0-javadoc.jar.asc
    │   ├── catppuccin-processing-1.0.0.pom
    │   ├── catppuccin-processing-1.0.0.pom.asc
    │   ├── catppuccin-processing-1.0.0-sources.jar
    │   ├── catppuccin-processing-1.0.0-sources.jar.asc
    │   └── _remote.repositories
    └── maven-metadata-local.xml

6 directories, 24 files

So I booted up an older codebase and put this into my pom.xml:

        <dependency>
            <groupId>com.catppuccin</groupId>
            <artifactId>catppuccin-java</artifactId>
            <version>2.0.0</version>
        </dependency>

Unfortunately, I keep getting the following error:

Could not find artifact com.catppuccin:catppuccin-java:jar:2.0.0 in central (https://repo.maven.apache.org/maven2)

I've made sure that the files exist, I've tried to inject the child modules, I've reindexed the local repository in Intellij, etc. I'm honestly at my wits end. Can anyone help me understand how to import the dependency from my local .m2 repository without going to Maven Central? I'd really appreciate it!

GitHub

GitHub - catppuccin/java: ☕ Soothing pastel theme for Java

☕ Soothing pastel theme for Java. Contribute to catppuccin/java development by creating an account on GitHub.

midnight elmBOT May 18, 2024, 1:55 PM

#

⌛ This post has been reserved for your question.

Hey @fathom trout! Please use /close or the Close Post button above when your problem is solved. Please remember to follow the help guidelines. This post will be automatically closed after 300 minutes of inactivity.

TIP: Narrow down your issue to simple and precise questions to maximize the chance that others will reply in here.

fathom trout May 18, 2024, 2:00 PM

#

Some more things I've tried is the -o flag for offline only builds that seems to error too

opaque lark May 18, 2024, 2:01 PM

#

u said u wanted to test it BEFORE publishing to m2
and the error its giving u says "cannot find it on m2"
this does not surprise me

there is a way to define a local folder as a repository to look in for downloads, give that a try for ur pre-publish test pull

fathom trout May 18, 2024, 2:01 PM

#

Indeed, I was under the impression that your local .m2 repository is always queried before going to Maven Central

opaque lark May 18, 2024, 2:02 PM

#

(i did it once for a repo i didnt want to publish) but i can remember exact details atm

#

ur checks in ur local if u have the data cached ...... but there is nothing upstream to have a cached copy of

fathom trout May 18, 2024, 2:03 PM

#

Oh interesting, so it won't find any repositories that don't at least have a version in Maven Central

vestal terrace May 18, 2024, 2:11 PM

#

fathom trout Indeed, I was under the impression that your local .m2 repository is always quer...

it is

#

are you sure your local maven repo is at the correct path and maven searches it? that the artefact is correct?

#

i think there's a way to tell maven to always look at the local repo

vestal terrace May 18, 2024, 2:12 PM

#

fathom trout Some more things I've tried is the `-o` flag for offline only builds that seems ...

yeah this is it, which error do you get then?

#

also try deleting the _remote.repositories files, maven apparently also checks those

fathom trout May 18, 2024, 2:14 PM

#

Yeah I did that too

fathom trout May 18, 2024, 2:15 PM

#

vestal terrace yeah this is it, which error do you get then?

Cannot access central (https://repo.maven.apache.org/maven2) in offline mode and the artifact com.catppuccin:catppuccin-java🫙2.0.0 has not been downloaded from it before. -> [Help 1]

#

Looks like I've just operating under the wrong assumption

vestal terrace May 18, 2024, 2:15 PM

#

vestal terrace also try deleting the _remote.repositories files, maven apparently also checks t...

you deleted those as well?

fathom trout May 18, 2024, 2:15 PM

#

Mhm tried that a while back when looking at a SO post with that same solution

#

The libraries that I've tested before were always single jar so I would just import them using Intellij and not bother with the poms

#

Since this was a multi module one, tried going the maven route and yeah it's been a bit painful lol

vestal terrace May 18, 2024, 2:16 PM

#

it's trying to get a jar artefact from the dependency, but catppuccin-java doesn't have one. try catppuccin-processing

fathom trout May 18, 2024, 2:16 PM

#

The confidence that I really want is to understand how the maven GAV coordinates would be formed for the multi module

#

like will this work once it's on maven central?

        <dependency>
            <groupId>com.catppuccin</groupId>
            <artifactId>catppuccin-java</artifactId>
            <version>2.0.0</version>
        </dependency>

vestal terrace May 18, 2024, 2:17 PM

#

i dont think so if its trying to get the jar artefact while it doesnt have one

#

what does the pom look like

fathom trout May 18, 2024, 2:18 PM

#

vestal terrace what does the pom look like

catppuccin-java is the parent pom, you can view the source here: https://github.com/catppuccin/java/blob/main/pom.xml

#

You can view the child poms by going into the palette/processing directories

#

We've had a successful publish up to nexus staging, I just wanted to see the jar(s) being imported locally via maven on a codebase before going all the way. hence this forum post lol

fathom trout May 18, 2024, 2:20 PM

#

vestal terrace i dont think so if its trying to get the jar artefact while it doesnt have one

https://github.com/catppuccin/java/actions/runs/9136768686 The generated JARs if you'd like to inspect them

vestal terrace May 18, 2024, 2:22 PM

#

you might want to make a BOM in that case, a bill of materials. what does the actual pom in your local repo for catppuccin-java look like?

#

it doesnt have to be the same pom as source, that's why im asking

fathom trout May 18, 2024, 2:22 PM

#

Another reason why I care is because the current version is single jar, I'm pretty certain the gav coordinates would be totally different when compared to the existing one: https://central.sonatype.com/artifact/com.catppuccin/catppuccin-palette/overview

Maven Central

Maven Central: com.catppuccin:catppuccin-palette

Discover catppuccin-palette in the com.catppuccin namespace. Explore metadata, contributors, the Maven POM file, and more.

fathom trout May 18, 2024, 2:23 PM

#

vestal terrace you might want to make a BOM in that case, a bill of materials. what does the ac...

Possibly

fathom trout May 18, 2024, 2:24 PM

#

vestal terrace you might want to make a BOM in that case, a bill of materials. what does the ac...

One minute

maiden sphinx May 18, 2024, 2:26 PM

#

Hi, from your first post we can see that "catppuccin-java" does not have any artifact. That is the reason why Maven try to search for it in Maven central

fathom trout May 18, 2024, 2:26 PM

#

Looks like they're the same

#

(left is from .m2, right is the source repo)

vestal terrace May 18, 2024, 2:27 PM

#

then i dont think it'll properly resolve the child poms. make a bom submodule: https://reflectoring.io/maven-bom/

Using Maven's Bill of Materials (BOM)

Resolving dependencies in Maven using a Bill Of Materials (BOM).

fathom trout May 18, 2024, 2:27 PM

#

maiden sphinx Hi, from your first post we can see that "catppuccin-java" does not have any art...

Hi 👋
Yes we've established that

fathom trout May 18, 2024, 2:27 PM

#

vestal terrace then i dont think it'll properly resolve the child poms. make a bom submodule: h...

Cheers, will look into that

#

Although, I thought the current catppuccin-java pom.xml acted as a BOM 🤔

#

TBF, this line is where I got that idea from: https://github.com/catppuccin/java/blob/d1bf059ea014e000f49a31216cbc28fcef911ec8/pom.xml#L9

midnight elmBOT May 18, 2024, 2:29 PM

#

fathom trout TBF, this line is where I got that idea from: https://github.com/catppuccin/java...

  <packaging>pom</packaging>

vestal terrace May 18, 2024, 2:29 PM

#

not really, it's the parent pom

#

parent pom and bom are different things, as funny as it sounds

fathom trout May 18, 2024, 2:29 PM

#

Hmmm but not mutually exclusive?

#

As in, a BOM can be a parent pom

vestal terrace May 18, 2024, 2:29 PM

#

eh kind of, its hard to make a parent pom a bom

fathom trout May 18, 2024, 2:29 PM

#

Just reading through the article you linked now

vestal terrace May 18, 2024, 2:30 PM

#

parent pom has the <modules>, a bom just references other dependencies that should be imported when using the bom in a project

fathom trout May 18, 2024, 2:30 PM

#

I see, I'm trying to think what's the easiest way forward for our usecase

#

I figured the current config would work with these gav coordinates below:

        <dependency>
            <groupId>com.catppuccin</groupId>
            <artifactId>catppuccin-java</artifactId>
            <version>2.0.0</version>
        </dependency>
``` But your comment earlier is interesting

fathom trout May 18, 2024, 2:34 PM

#

vestal terrace parent pom has the <modules>, a bom just references other dependencies that shou...

If the code was refactored to use the BOM without the <parent> tag, am I right in saying that it means we no longer have to publish the "parent" catppuccin-java because there is no more parent.

#

and that should mean you should be able to just import catppuccin-palette directory since your effective POM would be everything from the BOM and the palette's own pom.xml

vestal terrace May 18, 2024, 2:35 PM

#

fathom trout If the code was refactored to use the BOM without the `<parent>` tag, am I right...

i dont quite follow

#

if you do the bom approach, you will have an extra module with all of the dependencies of the project and nothing more in it. you will have to publish parent and all modules including the bom. users will then import the bom and get everything

fathom trout May 18, 2024, 2:36 PM

#

So, the first iteration of this project resulted in one single catppuccin-palette jar, which is currently published on maven central

#

Now we've done effectively a v2 rewrite which now has 2 modules, catppuccin-palette and catppuccin-processing and a parent catppuccin-java

#

I'm trying to understand how that impacts what users would now see on maven central when we publish. Initially I wanted to only upload the palette and processing JARs but I believe we need the parent catppuccin-java pom.xml since it is the parent

vestal terrace May 18, 2024, 2:38 PM

#

yes, correct

#

catppuccin-java is referenced as parent pom by all the modules, so it needs to be there to provide additional metadata

fathom trout May 18, 2024, 2:39 PM

#

Right so does that mean the user now has to explicitly pull in catppuccin-java and catppuccin-palette into their own pom.xml?

vestal terrace May 18, 2024, 2:39 PM

#

catppuccin-palette would pull in catppuccin-java, but that'd have no effect since -java has no actual artefacts in it

#

so no, they wouldnt have to manually add catppuccin-java

fathom trout May 18, 2024, 2:40 PM

#

Right of course, so users should just be able to write

        <dependency>
            <groupId>com.catppuccin</groupId>
            <artifactId>catppuccin-palette</artifactId>
            <version>2.0.0</version>
        </dependency>

vestal terrace May 18, 2024, 2:40 PM

#

yes

fathom trout May 18, 2024, 2:40 PM

#

And that is irrespective of whether we convert our current catppuccin-java pom.xml to a BOM?

#

It seems like what we have currently should work then once published to maven central?

vestal terrace May 18, 2024, 2:41 PM

#

which pom are you talking about? the one of catppuccin-palette?

#

the bom only makes sense when you want to provide a way for multiple dependencies to be imported in one dependency, if you have several modules that you think make sense together

#

if you just want users to include one or optionally both dependencies when needed, a bom doesnt make much sense. what you have now is good for that purpose

#

users can just pull in -palette or -processing at will, which will then as a result pull in -java as parent pom (which has no effect, but maven resolves it for metadata)

fathom trout May 18, 2024, 2:42 PM

#

Right, that gives me the confidence I needed

#

Thanks for taking your time out to reply

midnight elmBOT May 18, 2024, 2:42 PM

#

fathom trout Thanks for taking your time out to reply

If you are finished with your post, please close it.
If you are not, please ignore this message.
Note that you will not be able to send further messages here after this post have been closed but you will be able to create new posts.

fathom trout May 18, 2024, 2:43 PM

#

Appreciate the help, have a good day!

#How to import multi-module maven project from local .m2 repository?