diffplug / diffplug/spotless

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

Aperta
#1,942 1 commento 1 reazione 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
Java
Stelle
5.6k
Fork
559
Merge medio
1g 14h
PR unite (30g)
43

Descrizione

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).

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia da plugin-maven/README.md e rivedi gli esempi di plugin esistenti. Documenta le coordinate Maven per ogni plugin e includi un URL alternativo per gli strumenti senza artefatti Maven; consulta l’issue 1922 per il contesto greclipse a cui si fa riferimento. Il lavoro è completato quando il README espone le coordinate o un URL di versione utilizzabile per ogni esempio.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.