Skip to content
Astro LilyPond

Building and Deploying

astro build needs a lilypond binary to compile your scores. The binary can be downloaded by default, or you can manually install it yourself.

Automatic installation

Section titled “Automatic installation”

When autoInstall is enabled, running astro build will download the lilypond binary (if needed) and use it to compile your scores. This is helpful when your Astro site gets built by an external service like GitHub, Cloudflare, or Netlify.

Manual installation

Section titled “Manual installation”

On your computer

Section titled “On your computer”

When running astro-lilypond locally, you should install the LilyPond binary yourself so that you can use LilyPond in other tools.

Download LilyPond v2.26.0

Or install via Homebrew:

Terminal window
brew install lilypond

On GitHub Actions

Section titled “On GitHub Actions”

To manually install LilyPond using a Linux runner in GitHub Actions, run apt-get before your build step:

.github/workflows/deploy.yml
- name: Install LilyPond
  run: sudo apt-get update && sudo apt-get install -y lilypond

To fail the build if lilypond is not found, explicitly set autoInstall: false:

astro.config.mjs
lilypond({
  autoInstall: false
})

autoInstall: false will prevent the integration from falling back to a different binary if the manual installation isn’t found.