moonrepo / setup-toolchain

A GitHub action to setup and cache the proto and moon toolchains.

Setup proto and moon toolchains

A GitHub action that sets up an environment for proto and moon.

• Installs proto globally so that installed tools can also be executed globally.
• Conditionally installs moon globally if the repository is using moon (attempts to detect a .moon directory), or moon-version is set.
• Caches the toolchain (~/.proto) so subsequent runs are faster.
• Hashes .prototools and .moon/toolchain.yml files to generate a unique cache key.
• Cleans the toolchain before caching to remove unused or stale tools.

Installation

# ...
jobs:
  ci:
    name: CI
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: moonrepo/setup-toolchain@v0
        with:
          auto-install: true
      - run: moon ci

Inputs

• auto-install - Auto-install tools from the root .prototools on setup. Defaults to false.
• cache - Toggle caching of the toolchain directory. Defaults to true.
• cache-base - Base branch/ref to save a warmup cache on. Other branches/refs will restore from this base.
• moon-version - Version of moon to explicitly install.
• proto-version - Version of proto to explicitly install.
• workspace-root - Relative path to moon's workspace root if initialized in a sub-directory. Defaults to "".