GitHub Action
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
🚀 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
-
hayagriva-version
: Which version of Hayagriva to install. This can be an exact version specifier such as0.5.1
or a semver range like~0.5.0
or0.x
. Uselatest
to always install the latest release. Defaults tolatest
. -
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 thegithub.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 compiledhayagriva
binary for future runs.
-
hayagriva-version
: The version of Hayagriva that was installed. This will be something like0.5.1
or similar. -
cache-hit
: Whether or not Hayagriva was restored from the runner's cache or download anew.
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
.