Skip to content

README.md

Latest commit

 

History

History
60 lines (42 loc) · 1.74 KB

README.md

File metadata and controls

60 lines (42 loc) · 1.74 KB
Raw

GitHub Action: Setup Scripts

Idempotently bootstraps tomgrv/scripts's zz-use activator (a no-op if it's already on PATH), then optionally installs a specific list of its scripts — pinned to one shared ref, if given — so later steps in the job can call them directly.

Inputs

scripts

Optional. Space-separated tomgrv/scripts tool names to zz-use after bootstrapping (e.g. git-release-beta git-release-prod). Leave empty to only bootstrap zz-use itself, without installing anything.

scripts-ref

Optional. tomgrv/scripts ref (tag/branch/commit) every name in scripts is pinned to, applied as <name>@<ref>. Leave empty to use each script's own default origin/ref (its repo's default branch).

scripts-branch

Optional. Branch to fetch tomgrv/scripts setup.sh from when bootstrapping zz-use (default main, typically overridden to a development branch during integration testing).

Caching

zz-use (from tomgrv/scripts) already caches each extracted tomgrv/scripts archive locally, per origin/ref, under ~/.cache/zz_scripts. This action caches that directory across job runs via actions/cache, keyed on scripts-branch/scripts-ref, so the archive is only downloaded and extracted once per ref instead of on every run.

Works well with

  • release-promote — uses this action to install git-release-beta/git-release-prod before running them.

Local Usage

steps:
    - uses: tomgrv/actions/setup-scripts@v5
      with:
          scripts: json-validate json-merge
          scripts-ref: v5

    - run: json-validate --help

Example

- uses: tomgrv/actions/setup-scripts@v5