Skip to content

tombi-toml/setup-tombi

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

setup-tombi

This action sets up Tombi in your GitHub Actions workflow.

Usage

Basic usage

- uses: tombi-toml/setup-tombi@v1.1.3

This is the recommended form from setup-tombi@v1.1.0 onward. When with.version is omitted, the action installs the tombi CLI version that matches the setup-tombi release version.

Install a specific version

- uses: tombi-toml/setup-tombi@v1.1.3
  with:
    version: '1.0.0'

Install a version from a lock file

- uses: tombi-toml/setup-tombi@v1.1.3
  with:
    lockfile: 'uv.lock'

Install with checksum verification

For the archive

- uses: tombi-toml/setup-tombi@v1.1.3
  with:
    version: '1.0.0'
    archive-checksum: '<sha256-checksum>'

For the executable binary

- uses: tombi-toml/setup-tombi@v1.1.3
  with:
    version: '1.0.0'
    binary-checksum: '<sha256-checksum>'

Cache behavior

  • true: always enables cache.
  • false: always disables cache.
  • auto (default): enables cache unless the runner environment is self-hosted runner.

Use enable-cache: true only when you want to force cache on, for example on self-hosted runners.

- uses: tombi-toml/setup-tombi@v1.1.3
  with:
    enable-cache: true

Use a custom cache directory

- uses: tombi-toml/setup-tombi@v1.1.3
  with:
    enable-cache: true
  env:
    TOMBI_CACHE_HOME: ${{ runner.temp }}/tombi-cache

Inputs

Name Description Required Default
version Version of Tombi to install (e.g., "1.0.0", "latest"). When omitted, installs the Tombi version that matches the setup-tombi release version. Mutually exclusive with lockfile No setup-tombi release version
lockfile Path to a lock file used to resolve Tombi version. Supported: uv.lock, poetry.lock, pnpm-lock.yaml, package-lock.json, yarn.lock, bun.lock No -
archive-checksum SHA256 checksum to validate the downloaded archive before extraction. Accepts <hex> or sha256:<hex> No -
binary-checksum SHA256 checksum to validate the installed executable binary. Accepts <hex> or sha256:<hex> No -
checksum ⚠️ Deprecated. Alias for binary-checksum No -
enable-cache Persist the Tombi cache using GitHub Actions cache. Supports true, false, and auto No auto

Example workflow

name: TOML Validation

on:
  push:
    paths:
      - '**.toml'
  pull_request:
    paths:
      - '**.toml'

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: tombi-toml/setup-tombi@v1.1.3
      - name: Validate TOML files
        run: tombi lint

License

MIT

About

Set up Tombi in your GitHub Actions workflow

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors