A reference GitHub Workflow configuration can be found here . The only thing to note is the environment variable $PAGE_URL
, which is used to specify the URL of the page to be deployed. You can set these in the settings/variables/actions
section of your repository.
name: Deploy Kodama site to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
# Default to bash
defaults:
run:
shell: bash
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Install Kodama & Typst
run: |
cargo install --git https://github.com/kokic/kodama.git
sudo snap install typst
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build with Kodama
run: |
kodama c -b $PAGE_URL
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./publish
# Deployment job
deploy:
environment:
name: github-pages
url: $PAGE_URL
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4