Skip to content

utooland/setup-utoo

Repository files navigation

setup-utoo

GitHub Action for setting up Utoo - a unified frontend toolchain.

Usage

Basic Setup

- uses: utooland/setup-utoo@v1
  with:
    utoo-version: "latest"

Custom Registry

- uses: utooland/setup-utoo@v1
  with:
    utoo-version: "1.0.0"
    registry: "https://registry.npmjs.org/"

Cache Configuration

Cache installed Utoo binary to avoid reinstallation:

- uses: utooland/setup-utoo@v1
  with:
    utoo-version: "latest" # Works with 'latest', version ranges, or specific versions
    cache-utoo: true # Cache the installed Utoo binary

Cache npm store for faster package installations:

- uses: utooland/setup-utoo@v1
  with:
    utoo-version: "latest"
    cache-store: true # Cache ~/.cache/nm directory

Inputs

Input Description Default
utoo-version The version of Utoo to install (e.g. "latest", "1.0.0", "1.0.x") latest
registry The URL of the npm registry to use for installing Utoo https://registry.npmjs.org/
cache-utoo Cache installed Utoo commands to avoid reinstallation on subsequent runs. Automatically resolves "latest" to actual version for proper cache invalidation. true
cache-store Cache npm store directory (~/.cache/nm) for faster package installations false

Outputs

Output Description
utoo-version The version of Utoo that was installed
utoo-path The command path added to PATH
cache-hit Whether Utoo was restored from the cache

Example Workflow

name: Build with Utoo

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: utooland/setup-utoo@v1
        with:
          utoo-version: "latest"

      - name: Install dependencies
        run: utoo

      - name: Build project
        run: utoo build

Features

  • Registry Support: Configure custom npm registries
  • Dual Cache Support:
    • Utoo Command Cache: Cache the installed Utoo package and command shims
    • NPM Store Cache: Cache npm packages in ~/.cache/nm for faster package installations
  • Cross-platform: Works on Ubuntu, macOS, and Windows
  • Version Management: Support for specific versions and ranges

License

MIT

About

github actions for utoo

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages