Warn about use of ~/.m2/repository
#2929
Conversation
This directory is maven internal files-system cache. Its layout can change without prior notice. It also can contain POMs without corresponding jars (e.g. when a transitive dependency was evicted due to a version conflict) which confuses coursier. See problem reproduction and more details in https://github.com/ghostbuster91/demos/tree/coursier-not-found
There was a problem hiding this comment.
I saw these kind of warnings earlier in the source code and must say I don't like them as they are. That means, they are not actionable, so the used has no clue why they are risky, so they can't decide what risks they face and whether they want to deal with it or not.
The option to integrate with a local Maven repository is often the only choice to use another build tool than Maven. Therefore, this is a good feature, although it comes with some issues.
So we either add some links, e.g. the the issue you mentioned in the PR comment, or some text outlining the kind of issue a user should anticipate when using it. Maybe, also some workaround or fix actions.
|
I see your point. I expanded that section a bit, let me know if this is enough. |
We have just run ourselves into a weird issue with coursier where it would fail with artifact not found error. After closer inspection it turned out that it was because of use of ~/.m2/repository as a coursier repository.
I think that it would be great to add a warning to the documentation about this.
This was also mentioned here #1832 (comment)
This directory is maven internal files-system cache and afaik its layout can change without prior notice. It also can contain POMs without corresponding jars (e.g. when a transitive dependency was evicted due to a version conflict) which confuses coursier.
See problem reproduction and more details in https://github.com/ghostbuster91/demos/tree/coursier-not-found