Setup Biome CLI in GitHub Actions

Setup Biome is a GitHub action that provides a cross-platform interface for setting up the Biome CLI in GitHub Actions runners.

Inputs

The following inputs are supported.

- name: Setup Biome
  uses: biomejs/setup-biome@v2
  with:

    # The version of the Biome CLI to install.
    # This input is optional and by default the version will be automatically
    # detected from the project's dependencies. If no version is found in the
    # project's dependencies, the latest version of the Biome CLI will be installed.
    # Example values: "2.4.6", "latest"
    version: ""

    # The GitHub token to use to authenticate GitHub API requests.
    # This input is optional and defaults to the job's GitHub token.
    # Example value: ${{ secrets.GITHUB_TOKEN }}
    token: ${{ github.token }}

    # The directory in which the lockfile will be looked for when automatically
    # determining the version of the Biome CLI to install. Defaults to the current
    # working directory.
    working-dir: ""

Examples

Automatic version detection

To automatically determine the Biome version to install, simply omit the version input.

The action first looks for the version of the @biomejs/biome dependency in the lockfiles of popular package managers (npm, yarn, pnpm, bun). If no version can be determined from lockfiles, it will next check package.json. If neither lockfiles nor package.json provide a version, the action will then look for a declared version in the project's Biome configuration file (it extracts the version from the $schema field). If no version is found after these checks, the action installs the latest version of the Biome CLI.

- name: Setup Biome CLI
  uses: biomejs/setup-biome@v2

- name: Run Biome
  run: biome ci

Important

We recommend that you pin the version of @biomejs/biome in your project's dependencies. If you provide a semver range, and automatic version detection falls back to reading the package.json file, the highest version within the range will be used. See the versioning documentation for more information.

Latest version

Setup the latest version of the Biome CLI.

- name: Setup Biome CLI
  uses: biomejs/setup-biome@v2
  with:
    version: latest

- name: Run Biome
  run: biome ci

Specific version

Install version 2.4.6 of the Biome CLI.

- name: Setup Biome CLI
  uses: biomejs/setup-biome@v2
  with:
    version: 2.4.6

- name: Run Biome
  run: biome ci

License

Copyright © 2023, Nicolas Hedger. Released under the MIT License.