[RFE][Docs] Publish g:a:v in maven-plugin-documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- java
- Domain
- documentation
Research direction
Start with plugin-maven/README.md and review the existing plugin examples. Document Maven coordinates for every plugin, and include an alternative URL for tools without Maven artifacts; check issue 1922 for the referenced greclipse context. Done means the README exposes coordinates or a usable version URL for each example.
Written by the indexing model from the issue text.
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:
<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 https://github.com/diffplug/spotless/issues/1922).
- Dominant language
- Java
- Stars
- 5.7k
- Forks
- 560
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 43
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from diffplug/spotless
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 66/100
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 52/100
All issues in diffplug/spotless
Similar issues
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 90/100
apache/cloudstack#14222 ·
-
[BUG]茶杯方块在取茶时会引发崩溃 Open
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
1.0.0-alpha2 Type/Improvement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
wso2/dpdp-accelerator#272 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
area/frontend
Difficulty 2/5 1-3 hours Newbie friendliness 65/100