Workflow How To

GitHub Actions Workflow How-To

This guide explains the GitHub Actions automation pipelines configured for the retro-game-replicas repository, detailing how they run, how releases are compiled, and how packages are managed.

Available Workflows

1. Publish Releases & Packages (build-release.yml)

• Trigger: Triggered automatically when a release tag (e.g., v*) is pushed to the repository.
• Tasks Performed:
  • Lints and builds the Phaser game assets.
  • Uses Tauri compiler action (tauri-apps/tauri-action) to build native executables for:
    • Windows: x64 setup executable (.exe)
    • macOS: Apple Silicon dmg/app bundle (.dmg)
    • Linux: AppImage bundle (.AppImage)
  • Builds and pushes a Docker package to GitHub Container Registry (GHCR) at ghcr.io/biossystem/retro-game-replicas:latest.
  • Automatically creates a GitHub Release draft and attaches all compiled native binaries.

How to Release a New Version

1. Verify the code is clean and passes TypeScript compilation (npm run ts:check or tsc --noEmit).
2. Update version numbers in src-tauri/tauri.conf.json and package.json.
3. Commit and tag the commit (e.g. v1.1.3):

   git tag v1.1.3
   git push origin v1.1.3

4. The workflow will trigger automatically and build the desktop files, pushing them as release assets.