Overview

Deploy your Hwaro site to any static hosting provider.

Build for Production

  hwaro build --minify

This creates optimized files in public/.

Deployment Options

Static Hosts

Manual Deploy

Upload public/ folder to any web server:

  # rsync to server
rsync -avz public/ user@server:/var/www/html/

# AWS S3
aws s3 sync public/ s3://your-bucket/ --delete

# FTP
lftp -c "mirror -R public/ /public_html"

GitHub Actions

Using Hwaro Action (Recommended)

The easiest way to deploy to GitHub Pages is using the official Hwaro action:

  name: Deploy Hwaro Site

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Build and Deploy
        uses: hahwul/hwaro@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

With Custom Options

  - name: Build and Deploy
  uses: hahwul/hwaro@main
  with:
    token: ${{ secrets.GITHUB_TOKEN }}
    pages_branch: gh-pages
    build_dir: docs
    output_dir: public
    build_flags: "--drafts --minify"

Build Only (for Pull Requests)

  name: Hwaro CI

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    if: github.ref != 'refs/heads/main'
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Build Only
        uses: hahwul/hwaro@main
        with:
          build_only: true

  deploy:
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Build and Deploy
        uses: hahwul/hwaro@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

Action Inputs

Build Flags

You can pass any valid hwaro build flags:

• --drafts - Include draft content
• --minify - Minify HTML output
• --no-parallel - Disable parallel processing
• --cache - Enable build caching
• -o DIR - Custom output directory

Example:

  build_flags: "--drafts --minify --cache"

Manual Workflow (Alternative)

If you prefer not to use the action:

  name: Deploy

on:
  push:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Install Crystal
        uses: crystal-lang/install-crystal@v1
      
      - name: Build Hwaro
        run: |
          git clone https://github.com/hahwul/hwaro
          cd hwaro && shards build --release
          sudo cp bin/hwaro /usr/local/bin/
      
      - name: Build Site
        run: hwaro build --minify
      
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./public

Permissions

Make sure your repository has the correct permissions for GitHub Actions:

1. Go to Settings > Actions > General
2. Under Workflow permissions, select Read and write permissions
3. Save the changes

Custom Domain

If you're using a custom domain for your GitHub Pages site, place a CNAME file in your static/ directory:

  static/CNAME

Content:

  example.com

Hwaro will copy this file to the root of your built site.

Deploying to a Different Repository

To deploy to a different repository, use a Personal Access Token (PAT):

  - name: Build and Deploy to Another Repo
  uses: hahwul/hwaro@main
  with:
    token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
    repository: "owner/other-repo"

Post-Build Hooks

Automate deployment with build hooks:

  [build]
hooks.post = ["./scripts/deploy.sh"]

Example scripts/deploy.sh:

  #!/bin/bash
rsync -avz --delete public/ user@server:/var/www/html/

Environment Variables

For CI/CD pipelines:

  # Set base_url for production
export HWARO_BASE_URL="https://example.com"
hwaro build --minify

In This Section