diffplug / diffplug/spotless

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

Open
#1,942 1 comment 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
5.6k
Forks
559
Avg merge
1d 13h
Merged PRs (30d)
34

Description

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:

```xml

com.palantir.javaformat
palantir-java-format
2.38.0

```

## 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 https://github.com/diffplug/spotless/issues/1922).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.