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

v1.0.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.

If some files need to be formatted, this action will push a commit with the modifications (unless you 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 # required
      - uses: axel-op/[email protected]
        with:
          args: "--aosp --replace"

Inputs

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

files

The files to format. It can be a list of filenames separated by a space, like this:

          files: "file1.java file2.java file3.java"

If you don't specify it, all Java files in your repository are formatted.

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.

--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.