Skip to content

docs: Recommend fixing google-java-format version on README #202

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
merged 2 commits into from
Sep 11, 2025
Merged

docs: Recommend fixing google-java-format version on README #202

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8afcd4
docs: Recommend fixing google-java-format version on README
vorburger Jun 20, 2025
130d3e3
Merge branch 'main' into patch-1
andreasfolkesson Sep 11, 2025
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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,23 @@ To have your sources automatically formatted on each build, add to your pom.xml:
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>com.google.googlejavaformat</groupId>
<artifactId>google-java-format</artifactId>
<version>1.27.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
```

The inclusion of the `google-java-format` as a dependency allows you to control that version,
which is generally recommended, so that you can align it with the exact version used in your
IDE, pre-commit Git hook, etc. (If you are fine getting "whatever version `fmt-maven-plugin`
uses" then you could omit it.)

If you prefer, you can only check formatting at build time using the `check` goal:

```xml
Expand Down
Loading