Skip to main content
jolterjs/setup-jolter@v1 is planned future behavior. Use the installer plus jolter setup-ci until the action is released.
The setup action should be a thin GitHub Actions wrapper around Jolter itself. It should install Jolter, restore or save cache data, run jolter setup-ci, add shims to PATH, and expose resolved versions as outputs.

​
Intended usage

.github/workflows/test.yml
name: Test

on:
  push:
  pull_request:

jobs:
  test:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v6

      - name: Set up Jolter
        id: jolter
        uses: jolterjs/setup-jolter@v1
        with:
          cache: true
          install-plugins: false

      - name: Test
        run: |
          node --version
          pnpm --version
          pnpm test

​
Intended inputs

InputDefaultPurpose
versionlatestJolter version or release selector to install
jolter-homerunner temporary directoryStorage root used for the job
cachetrueRestore and save $JOLTER_HOME/cache
cache-dependency-pathcommon requirement filesFiles used to build the cache key
install-pluginsfalseRun jolter setup-ci --yes for missing project plugins
no-progresstrueUse stable line-oriented logs

​
Intended outputs

OutputExample
runtimenode@24.5.0
toolspnpm@10.12.1,yarn@4.9.2
plugins@eslint/eslint@1.0.0
cache/home/runner/work/_temp/jolter-home/cache
shims/home/runner/work/_temp/jolter-home/shims

​
Intended behavior

The action should:
  1. download or reuse the requested Jolter version;
  2. set JOLTER_HOME;
  3. restore cache when enabled;
  4. run jolter setup-ci or jolter setup-ci --yes;
  5. add the shims directory to PATH;
  6. expose runtime, tools, plugins, cache, and shims outputs;
  7. save cache after successful setup when enabled.
The action should not reimplement resolution rules. Jolter itself remains the source of truth.

​
Plugin projects

When a project declares plugins: 
- uses: jolterjs/setup-jolter@v1
  with:
    install-plugins: true
This should map to: 
jolter setup-ci --yes --no-progress
Without install-plugins: true, missing declared plugins should fail clearly instead of silently installing new code.

​
Migration path

Today: 
- run: |
    curl -fsSL https://get.jolter.dev/install.sh | sh
    jolter setup-ci --no-progress
After the action ships: 
- uses: jolterjs/setup-jolter@v1
Both paths should produce the same runtime, tool, plugin, cache, and shim behavior because both rely on jolter setup-ci.

Related topics

Command referenceGitHub ActionsEnvironment variablesFirst project