Setup Hayagriva

🏷️ Installs the Hayagriva CLI for GitHub Actions

- uses: jcbhmr/setup-hayagriva@v1
- run: hayagriva literature.yml reference --style apa

✅ Installs the hayagriva CLI globally
📌 Supports version pinning
⚡ Caches the compiled binary using @actions/cache
📥 Downloads from the Hayagriva GitHub releases

Usage

🚀 Here's what you're after:

on: push
jobs:
  job:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: jcbhmr/setup-hayagriva@v1
      - run: hayagriva literature.yml reference

Inputs

hayagriva-version: Which version of Hayagriva to install. This can be an exact version specifier such as 0.5.1 or a semver range like ~0.5.0 or 0.x. Use latest to always install the latest release. Defaults to latest.
hayagriva-token: The GitHub token to use when fetching the version list from typst/hayagriva. You shouldn't have to touch this. The default is the github.token if you're on github.com or unauthenticated (rate limited) if you're not on github.com.
cache: Whether or not to use the workflow cache to cache the compiled hayagriva binary for future runs.

Outputs

hayagriva-version: The version of Hayagriva that was installed. This will be something like 0.5.1 or similar.
cache-hit: Whether or not Hayagriva was restored from the runner's cache or download anew.

Development

This GitHub Action uses Bun to bundle the main entry point plus all the imported dependencies into a single .js file ready to be run by main: dist/main.js in the action.yml. To test the action just open a PR (even a draft one) and some magic GitHub Actions will test your changes. 🧙‍♂️

ℹ Once Bun gets Windows support make sure you add back the runs-on: windows-latest test to test-action.yml.

Recommend Projects