GitHub Actions Usage Guide

Build Pake apps online without installing development tools locally.

Quick Steps

  1. Fork this project

  2. In your fork, open the Actions tab, select Build App With Pake CLI, fill in the form (same parameters as CLI options), and click Run Workflow

    Actions Interface

  3. A green checkmark means the build succeeded, click the workflow name and download your app from the Artifacts section

    Build Success

The first run builds the dependency cache and takes about 10-15 minutes, later runs use the cache and take about 5 minutes, and the complete cache is 400-600MB.

Form Inputs

FieldWhat it doesDefault
PlatformRunner to build on: windows-latest, macos-latest or ubuntu-24.04macos-latest
Website URLThe site to package, requirednone
App name (lowercase for Linux)App name and artifact prefix, requirednone
Icon URL, auto-fetch if emptyIcon for the app, fetched from the site when emptyempty
Window width (px)Initial window width1200
Window height (px)Initial window height780
Minimum window width (px)Smallest width the window can shrink toempty
Minimum window height (px)Smallest height the window can shrink toempty
App versionVersion written into the package1.0.0
Start in fullscreen modeOpen the app in fullscreenoff
Hide title bar (macOS only)Hide the window title baroff
Allow sites to open new windowsLet the site open pop-up windowsoff
Universal binary (macOS only)Build one app for Intel and Apple Siliconoff
Package formats (comma-separated: deb,appimage,rpm,zst)Linux package formats, ignored on other platformsdeb

Artifacts

Each run uploads the package as an artifact named after the app: <name>-macOS holds the .dmg, <name>-Windows the .msi, and Linux gets one artifact per format, <name>-Linux-deb, <name>-Linux-AppImage, <name>-Linux-rpm and <name>-Linux-zst. Artifacts are kept for 3 days, so download them soon after the build. Instead of the Artifacts section, you can also fetch them with the GitHub CLI: gh run download RUN_ID.

Tips

  • Enable Allow sites to open new windows when the site launches sign-in, exam, or other flows in a separate window
  • If a build fails, clear the Actions cache and retry

For a step-by-step walkthrough, with every form input, the artifact names and what to do when a run fails, read Build a website app with Pake on GitHub Actions.