mrworthington / friendly-sample

An example Quarto site built using the quarto-render action.

Quarto render for Github Actions

This repository is a demonstration of the quarto-render (link) Github action on a Quarto project with freeze.

The documents in this directory contain R and Python code that require various libraries to complete their computations. By setting freeze: true in _quarto.yml, computations are not re-executed at render time and documents are rendered more quickly. This means we can use the quarto-render action to quickly generate our documents as part of a Github workflow. Below is the workflow used by this directory that uses the quarto-render Github action and pushes the resulting documents to the gh-pages branch with action-gh-pages (link).

Github Workflow

# .github/workflows/quarto-render.yml
name: Render and deploy Quarto files
on: 
  push:
  pull_request:

jobs:
  quarto-render-and-deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: "Install Quarto and render"
      uses: pommevilla/quarto-render@main

    - name: "Deploy to gh-pages"
      uses: peaceiris/actions-gh-pages@v3
      if: github.ref == 'refs/heads/master'
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./_site

The final results can be viewed here.