Show the Maven plugin in the README - #84
Merged
Merged
Conversation
dev.openjavaformat:fmt-maven-plugin 2.27.0.1 is on Maven Central, released from openjavaformat/fmt-maven-plugin, and openjavaformat.dev has a Get started page for it. The README now names it among the Maven Central artifacts, links that page, and shows the plugin block a pom.xml needs. The block names the open-java-format version as well, because the plugin brings no formatter of its own and a build without the dependency stops. The snippet was run against the published 2.27.0.1 with 2.98.0.4.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Before this PR
The README lists where open-java-format is published and links a Get started page for each
integration, but says nothing about Maven.
dev.openjavaformat:fmt-maven-plugin2.27.0.1 is now onMaven Central, released from openjavaformat/fmt-maven-plugin,
and openjavaformat.dev documents it.
After this PR
==COMMIT_MSG==
The README shows the Maven plugin:
dev.openjavaformat:fmt-maven-pluginand links its repository;pom.xmlblock adds the plugin with theformatgoal and the open-java-format version it runs,which is required because the plugin brings no formatter of its own.
==COMMIT_MSG==
The snippet was run against the published 2.27.0.1 with 2.98.0.4: the plugin's output matches the
command line byte for byte, and a build without the dependency stops with a message that names it.
Possible downsides?
The block names 2.27.0.1 and 2.98.0.4 literally, so it has to be bumped with releases. The site takes
both versions from variables.