Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
align-right

GitHub Action

Google Java Format

v3.1.0

Google Java Format

align-right

Google Java Format

Automatically format Java files using Google Java Style

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Google Java Format

              
  uses: axel-op/[email protected]
Learn more about this action in axel-op/googlejavaformat-action

Choose a version

Google Java Format Action

Automatically format your Java files using Google Java Style guidelines.

This action automatically downloads the latest release of the Google Java Format program.

If some files need to be formatted, this action will push a commit with the modifications (unless you set the skipCommit input to true, or use the --dry-run argument, see below).

You must checkout your repository with actions/checkout before calling this action (see the example).

Example

# Example workflow
name: Format

on:
  push:
    branches:
      - master

jobs:

  formatting:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2 # v2 minimum required
      # Recommended: latest versions of Google Java Format require JDK 11+
      - uses: actions/setup-java@v1
        with:
          java-version: "11"
      - uses: axel-op/googlejavaformat-action@v3
        with:
          args: "--skip-sorting-imports --replace"

Inputs

None of these inputs is required, but you can add them to change the behavior of this action.

version

Set this input to use a specific version of Google Java Format. For example: 1.7, 1.8...

files

A pattern to match the files to format. The default is **/*.java, which means that all Java files in your repository will be formatted.

skipCommit

Set to true if you don't want the changes to be committed by this action. Default: false.

args

The arguments to pass to the Google Java Format executable. By default, only --replace is used.

-i, -r, -replace, --replace
  Send formatted output back to files, not stdout.

--assume-filename, -assume-filename
  File name to use for diagnostics when formatting standard input (default is <stdin>).

--aosp, -aosp, -a
  Use AOSP style instead of Google Style (4-space indentation).

--fix-imports-only
  Fix import order and remove any unused imports, but do no other formatting.

--skip-sorting-imports
  Do not fix the import order. Unused imports will still be removed.

--skip-removing-unused-imports
  Do not remove unused imports. Imports will still be sorted.

--skip-reflowing-long-strings
  (JDK 11+) Do not reflow string literals that exceed the column limit.

--skip-javadoc-formatting
  (JDK 11+) Do not reformat javadoc.

--dry-run, -n
  Prints the paths of the files whose contents would change if the formatter were run normally.

--set-exit-if-changed
  Return exit code 1 if there are any formatting changes.

--length, -length
  Character length to format.

--lines, -lines, --line, -line
  Line range(s) to format, like 5:10 (1-based; default is all).

--offset, -offset
  Character offset to format (0-based; default is all).

Note:

  • If you add --dry-run or -n, no commit will be made.
  • The argument --set-exit-if-changed will work as expected and this action will fail if some files need to be formatted.