Skip to content
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

[RFE][Docs] Publish g:a:v in maven-plugin-documentation #1942

Open
bmarwell opened this issue Dec 4, 2023 · 1 comment
Open

[RFE][Docs] Publish g:a:v in maven-plugin-documentation #1942

bmarwell opened this issue Dec 4, 2023 · 1 comment

Comments

@bmarwell
Copy link

bmarwell commented Dec 4, 2023

This is a recommendation / request for enhancement for https://github.com/diffplug/spotless/blob/main/plugin-maven/README.md.

feature description

Please publish the Maven coordinates for every plugin.
E.g. palantir:

<dependency>
    <groupId>com.palantir.javaformat</groupId>
    <artifactId>palantir-java-format</artifactId>
    <version>2.38.0</version>
</dependency>

use case

Users can easily find new versions

Users can use the coordinates and go to https://search.maven.org/ to see whether there are more recent versions, or older versions if needed.

can be picked up by dependency bots

If you put the above into your dependency management, preferably using a property for the version, tools like renovate or dependabot can update the dependency.
With the current examples, those versions will never be picked up.

can be scanned by security scanners

If you put the above into your dependency management, security scanners will recognise the artefact, too.

versions without Maven artefacts

For tools like greclipse, publish another URL which can be used.
(optional) For greclipse specifically, show the Maven coordinates for the older versions (as mentioned in #1922).

@nedtwigg
Copy link
Member

nedtwigg commented Dec 4, 2023

PRs welcome. One of the situations Spotless handles is that maven artifacts move around over time. e.g. ktlint I think has lived at three different g:a coordinates while Spotless has supported it, and as an end user you could just set the version and Spotless knew which g:a to fetch it from.

I would focus on a particular formatter that you care about, and then make the docs / etc. how you want for that one formatter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants