Provide examples for conflict resolution on custom dependencies

[ketan]

Hello,

It's unclear (to me, at least) how I'd go about providing conflict resolution for dependencies that are not directly supported by this plugin. My use case in this particular case is that I have a transitive dependency on dk.brics.automaton:automaton:1.11-8 which has now been superceeded by dk.brics:automaton:1.12-4 (note a change in the maven coordinates). How do I go about defining such replacement rules via this plugin?

Thanks in advance.

[ketan]

I think I figured it out, but do call out if this is the right way to approach this problem. Happy to contribute back to the documentation.

jvmDependencyConflicts {
    conflictResolution {
        selectHighestVersion("org.example:some-feature")
    }

    patch {
        module("org.example:old-name") {
            addCapability("org.example:some-feature")
        }

        module("org.example.somepackage:new-name") {
            addCapability("org.example:some-feature")
        }
    }
}

[jjohannes]

@ketan yes what you figured out is correct.

And yes, this is probably something that should be documented with an example. The documentation of all the "patch" features is found here:

• https://gradlex.org/jvm-dependency-conflict-resolution/#patch-dsl-block
• https://github.com/gradlex-org/jvm-dependency-conflict-resolution/blob/main/src/docs/asciidoc/parts/resolution.adoc#patch-metadata-of-published-components

It only has the table of the functionality available, but does not show common use cases and how to address them. Maybe we can add a subsection for each use case that is "common". Starting with this one.

A PR for adding this to the docs would be appreciated!

Also, feel free to create a PR to contribute the Rule for dk.brics.automaton to the plugin (in CapabilityDefinition enum).

[jjohannes]

I added the rule for your case to the plugin (will be in 2.3): #222

[jjohannes]

I added contributing instructions to the Readme: https://github.com/gradlex-org/jvm-dependency-conflict-resolution?tab=readme-ov-file#contributing-new-capability-rules

These include an example for how to add a capability rule to your own build first.

I still think we can improve the user documentation as outlined above. I'll keep this issue open for that.