Skip to content

Show the released versions in the README #7

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.

Sign up for GitHub

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

Merged
abashev merged 2 commits into from
Sep 25, 2026
Merged

Show the released versions in the README #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7642fcb
Show the released versions in the README
abashev Sep 25, 2026
883ed02
Merge branch 'main' into readme-released-versions
abashev Sep 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
[![Build Status](https://github.com/openjavaformat/fmt-maven-plugin/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/openjavaformat/fmt-maven-plugin/actions/workflows/ci.yml?query=branch%3Amain)
[![license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/openjavaformat/fmt-maven-plugin/blob/main/LICENSE)
[![Maven Central](https://img.shields.io/maven-central/v/dev.openjavaformat/fmt-maven-plugin)](https://central.sonatype.com/artifact/dev.openjavaformat/fmt-maven-plugin)
[![Maven Central](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fdev%2Fopenjavaformat%2Ffmt-maven-plugin%2Fmaven-metadata.xml&label=Maven%20Central)](https://central.sonatype.com/artifact/dev.openjavaformat/fmt-maven-plugin)

## fmt-maven-plugin

Formats your code using [open-java-format](https://openjavaformat.dev), a modern, lambda-friendly, 120-character Java formatter.

**Documentation: [openjavaformat.dev/get-started/maven](https://openjavaformat.dev/get-started/maven/)**

This is a fork of [spotify/fmt-maven-plugin](https://github.com/spotify/fmt-maven-plugin), which formats with google-java-format. It works the same way, with open-java-format in its place.

The format cannot be configured by design.
Expand All @@ -24,7 +26,7 @@ To have your sources automatically formatted on each build, add to your pom.xml:
<plugin>
<groupId>dev.openjavaformat</groupId>
<artifactId>fmt-maven-plugin</artifactId>
<version>VERSION</version>
<version>2.27.0.1</version>
<executions>
<execution>
<goals>
Expand All @@ -36,7 +38,7 @@ To have your sources automatically formatted on each build, add to your pom.xml:
<dependency>
<groupId>dev.openjavaformat</groupId>
<artifactId>open-java-format</artifactId>
<version>2.98.0.3</version>
<version>2.98.0.4</version>
</dependency>
</dependencies>
</plugin>
Expand All @@ -54,7 +56,7 @@ If you prefer, you can only check formatting at build time using the `check` goa
<plugin>
<groupId>dev.openjavaformat</groupId>
<artifactId>fmt-maven-plugin</artifactId>
<version>VERSION</version>
<version>2.27.0.1</version>
<executions>
<execution>
<goals>
Expand All @@ -66,7 +68,7 @@ If you prefer, you can only check formatting at build time using the `check` goa
<dependency>
<groupId>dev.openjavaformat</groupId>
<artifactId>open-java-format</artifactId>
<version>2.98.0.3</version>
<version>2.98.0.4</version>
</dependency>
</dependencies>
</plugin>
Expand Down Expand Up @@ -138,7 +140,7 @@ example:
<plugin>
<groupId>dev.openjavaformat</groupId>
<artifactId>fmt-maven-plugin</artifactId>
<version>VERSION</version>
<version>2.27.0.1</version>
<configuration>
<sourceDirectory>some/source/directory</sourceDirectory>
<testSourceDirectory>some/test/directory</testSourceDirectory>
Expand Down Expand Up @@ -182,7 +184,7 @@ example to not display the non-compliant files:
<plugin>
<groupId>dev.openjavaformat</groupId>
<artifactId>fmt-maven-plugin</artifactId>
<version>VERSION</version>
<version>2.27.0.1</version>
<configuration>
<displayFiles>false</displayFiles>
</configuration>
Expand All @@ -205,7 +207,7 @@ example to limit the display up to 10 files
<plugin>
<groupId>dev.openjavaformat</groupId>
<artifactId>fmt-maven-plugin</artifactId>
<version>VERSION</version>
<version>2.27.0.1</version>
<configuration>
<displayLimit>10</displayLimit>
</configuration>
Expand All @@ -228,7 +230,7 @@ example to only warn about non-compliant files instead of failing the build
<plugin>
<groupId>dev.openjavaformat</groupId>
<artifactId>fmt-maven-plugin</artifactId>
<version>VERSION</version>
<version>2.27.0.1</version>
<configuration>
<failOnError>false</failOnError>
</configuration>
Expand Down Expand Up @@ -259,7 +261,7 @@ You can pass parameters via standard `-D` syntax.

### Requirements

The plugin needs Maven 3.9.6 or newer, running on JDK 21 or newer: open-java-format is compiled for Java 21, and the plugin formats in a JVM started from the same JDK.
Maven has to run on JDK 21 or newer: open-java-format is compiled for Java 21, and the plugin formats in a JVM started from the same JDK.

### Building

Expand Down
Loading