Skip to content
umbrella

GitHub Action

Run buildifier

v1.0.1 Latest version

Run buildifier

umbrella

Run buildifier

Runs Bazel's lint tool buildifier

Installation

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

 
              
- name: Run buildifier

              
  uses: jbajic/[email protected]
Learn more about this action in jbajic/buildifier

Choose a version

buildifier action

verify-run-buildifier.yml

GitHub Action for running Bazel's build tool buildifier. Works on linux, macOS and windows.

Buildifier automatically checks one of the Bazel's files:

  • BUILD
  • WORKSPACE
  • .bzl

Inputs

Name Description Required Default
version The version of the used buildifier false 6.0.0
path The path on which to run buildifier check. false .
mode The mode in which to run buildifier [check|diff] false check

Example Usage

To use buildifier action you can follow presented examples to see how it works:

Check every file

name: Bazel files check
on: [push]
jobs:
  formatting-check:
    name: Run buildifier check
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3

    - name: Run buildifier
      uses: jbajic/buildifier@v1

Check files in src directory

name: Check bazel files
on: [push]
jobs:
  formatting-check:
    name: Run buildifier check
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3

    - name: Run buildifier
      uses: jbajic/buildifier@v1
      with:
        path: src

Check all Bazel files and print out the difference

name: Check bazel files
on: [push]
jobs:
  formatting-check:
    name: Run buildifier check
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3

    - name: Run buildifier
      uses: jbajic/buildifier@v1
      with:
        path: src
        mode: diff

To print out the diff two steps will be performed:

  1. Run buildifier in multi_diff mode,
  2. Run git diff and print out the changes.

License

Apache-2.0