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

GitHub Action

Setup Biome

v1.0

Setup Biome

terminal

Setup Biome

Setup the Biome CLI in GitHub Actions

Installation

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

 
              
- name: Setup Biome

              
  uses: biomejs/[email protected]
Learn more about this action in biomejs/setup-biome

Choose a version

Setup Biome CLI in GitHub Actions

GitHub release (latest SemVer) Test Integrate

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: nhedger/setup-biome@v1
  with:

    # The version of the Biome CLI to install.
    # This input is optional and defaults to "latest".
    # Example values: "1.2.0", "latest"
    version: "latest"

    # 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 }}

Examples

Basic example

Setup the latest version of the Biome CLI.

- name: Setup Biome CLI
  uses: nhedger/setup-biome@v1

- name: Run Biome
  run: biome ci .

Specific version

Install version 1.2.0 of the Biome CLI.

- name: Setup Biome CLI
  uses: nhedger/setup-biome@v1
  with:
    version: 1.2.0

- name: Run Biome
  run: biome ci .

License

The scripts and documentation in this project are licensed under the MIT License.