|
| 1 | +# Multi-Platform Release Process |
| 2 | + |
| 3 | +This document explains how to create releases for both local agents using GitHub Actions. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +We have two separate agents with independent release cycles: |
| 8 | + |
| 9 | +1. **Local Browser Agent** - Browser automation with Nova Act |
| 10 | +2. **Local Agent** - GUI automation with PyAutoGUI |
| 11 | + |
| 12 | +Each agent builds for **macOS (Intel + Apple Silicon), Windows, and Linux** automatically via GitHub Actions. |
| 13 | + |
| 14 | +## Release Process |
| 15 | + |
| 16 | +### 1. Browser Agent Release |
| 17 | + |
| 18 | +```bash |
| 19 | +# Ensure you're on main and up to date |
| 20 | +git checkout main |
| 21 | +git pull origin main |
| 22 | + |
| 23 | +# Create and push a tag |
| 24 | +git tag browser-agent-v0.1.0 |
| 25 | +git push origin browser-agent-v0.1.0 |
| 26 | +``` |
| 27 | + |
| 28 | +This triggers `.github/workflows/release-browser-agent.yml` which: |
| 29 | +- ✅ Builds on macOS (Intel + ARM64), Windows (x64), Linux (x64) |
| 30 | +- ✅ Creates DMG, MSI, and DEB installers |
| 31 | +- ✅ Bundles Python dependencies (Nova Act, Playwright, boto3) |
| 32 | +- ✅ Creates a **draft** GitHub release with all artifacts |
| 33 | + |
| 34 | +### 2. Local Agent Release |
| 35 | + |
| 36 | +```bash |
| 37 | +# Create and push a tag |
| 38 | +git tag local-agent-v0.2.0 |
| 39 | +git push origin local-agent-v0.2.0 |
| 40 | +``` |
| 41 | + |
| 42 | +This triggers `.github/workflows/release-local-agent.yml` which: |
| 43 | +- ✅ Builds on macOS (Intel + ARM64), Windows (x64), Linux (x64) |
| 44 | +- ✅ Creates DMG, MSI, and DEB installers |
| 45 | +- ✅ Bundles Python dependencies (PyAutoGUI, OpenCV, Pillow) |
| 46 | +- ✅ Creates a **draft** GitHub release with all artifacts |
| 47 | + |
| 48 | +### 3. Review and Publish |
| 49 | + |
| 50 | +1. Go to [GitHub Releases](https://github.com/YOUR_ORG/step-functions-agent/releases) |
| 51 | +2. Find your **draft** release |
| 52 | +3. Review the artifacts: |
| 53 | + - macOS DMG files (Intel and ARM64) |
| 54 | + - Windows MSI installer |
| 55 | + - Linux DEB package |
| 56 | +4. Edit release notes if needed |
| 57 | +5. Click **Publish release** |
| 58 | + |
| 59 | +## Tag Naming Convention |
| 60 | + |
| 61 | +- **Browser Agent**: `browser-agent-v{MAJOR}.{MINOR}.{PATCH}` |
| 62 | + - Example: `browser-agent-v0.1.0` |
| 63 | +- **Local Agent**: `local-agent-v{MAJOR}.{MINOR}.{PATCH}` |
| 64 | + - Example: `local-agent-v0.2.0` |
| 65 | + |
| 66 | +## Manual Triggering |
| 67 | + |
| 68 | +You can also trigger builds manually without tags: |
| 69 | + |
| 70 | +1. Go to Actions → Select workflow |
| 71 | +2. Click "Run workflow" |
| 72 | +3. Select branch |
| 73 | +4. Click "Run workflow" button |
| 74 | + |
| 75 | +## What Gets Built |
| 76 | + |
| 77 | +### Browser Agent Installers |
| 78 | + |
| 79 | +| Platform | Architecture | File | Size (approx) | |
| 80 | +|----------|--------------|------|---------------| |
| 81 | +| macOS | ARM64 (M1/M2/M3) | `Local.Browser.Agent_0.1.0_aarch64.dmg` | ~4MB | |
| 82 | +| macOS | Intel (x64) | `Local.Browser.Agent_0.1.0_x64.dmg` | ~4MB | |
| 83 | +| Windows | x64 | `Local.Browser.Agent_0.1.0_x64_en-US.msi` | ~3MB | |
| 84 | +| Linux | x64 | `local-browser-agent_0.1.0_amd64.deb` | ~3MB | |
| 85 | + |
| 86 | +### Local Agent Installers |
| 87 | + |
| 88 | +| Platform | Architecture | File | Size (approx) | |
| 89 | +|----------|--------------|------|---------------| |
| 90 | +| macOS | ARM64 (M1/M2/M3) | `Local.Agent_0.2.0_aarch64.dmg` | ~3MB | |
| 91 | +| macOS | Intel (x64) | `Local.Agent_0.2.0_x64.dmg` | ~3MB | |
| 92 | +| Windows | x64 | `Local.Agent_0.2.0_x64_en-US.msi` | ~2.5MB | |
| 93 | +| Linux | x64 | `local-agent_0.2.0_amd64.deb` | ~2.5MB | |
| 94 | + |
| 95 | +**Note**: Installers are small because Python dependencies are downloaded on first run via `SETUP.sh` (macOS/Linux) or `SETUP.ps1` (Windows). |
| 96 | + |
| 97 | +## Installation Instructions |
| 98 | + |
| 99 | +### macOS |
| 100 | + |
| 101 | +```bash |
| 102 | +# Download and open DMG |
| 103 | +open Local.Browser.Agent_*.dmg |
| 104 | + |
| 105 | +# Drag app to Applications folder |
| 106 | +# First run: System Preferences → Security → Allow |
| 107 | + |
| 108 | +# Run setup |
| 109 | +open "/Applications/Local Browser Agent.app" |
| 110 | +# Click "Setup Python Environment" in UI |
| 111 | +``` |
| 112 | + |
| 113 | +### Windows |
| 114 | + |
| 115 | +```powershell |
| 116 | +# Run MSI installer (double-click or): |
| 117 | +msiexec /i Local.Browser.Agent_*.msi |
| 118 | +
|
| 119 | +# Run setup script |
| 120 | +cd "C:\Program Files\Local Browser Agent" |
| 121 | +.\SETUP.ps1 |
| 122 | +
|
| 123 | +# Or use batch file |
| 124 | +.\SETUP.bat |
| 125 | +``` |
| 126 | + |
| 127 | +### Linux (Ubuntu/Debian) |
| 128 | + |
| 129 | +```bash |
| 130 | +# Install DEB package |
| 131 | +sudo dpkg -i local-browser-agent_*.deb |
| 132 | +sudo apt-get install -f # Fix dependencies |
| 133 | + |
| 134 | +# Run setup |
| 135 | +cd /opt/local-browser-agent # or wherever installed |
| 136 | +./SETUP.sh |
| 137 | +``` |
| 138 | + |
| 139 | +## Troubleshooting |
| 140 | + |
| 141 | +### Build Fails on Specific Platform |
| 142 | + |
| 143 | +1. Check the Actions tab for detailed logs |
| 144 | +2. Common issues: |
| 145 | + - **macOS**: Code signing (can be disabled for testing) |
| 146 | + - **Windows**: Missing Visual Studio Build Tools |
| 147 | + - **Linux**: Missing system libraries (webkit, gtk) |
| 148 | + |
| 149 | +### Python Dependencies Not Installing |
| 150 | + |
| 151 | +- Ensure `requirements.txt` (browser-agent) or `pyproject.toml` (local-agent) is up to date |
| 152 | +- Check uv installation in GitHub Actions logs |
| 153 | +- Verify Python 3.11 compatibility |
| 154 | + |
| 155 | +### Large File Sizes |
| 156 | + |
| 157 | +If installers become too large: |
| 158 | +1. Check `.taurignore` is excluding unnecessary files |
| 159 | +2. Ensure `.venv` directories are not bundled |
| 160 | +3. Review bundle configuration in `tauri.conf.json` |
| 161 | + |
| 162 | +## Future Improvements |
| 163 | + |
| 164 | +- [ ] Add code signing for macOS (requires Apple Developer account) |
| 165 | +- [ ] Add code signing for Windows (requires certificate) |
| 166 | +- [ ] Add auto-update functionality (Tauri updater) |
| 167 | +- [ ] Combine agents into unified local agent |
| 168 | +- [ ] Add Linux AppImage format |
| 169 | +- [ ] Add macOS Homebrew cask |
| 170 | +- [ ] Add Windows Chocolatey package |
| 171 | + |
| 172 | +## Workflow Configuration Files |
| 173 | + |
| 174 | +- `.github/workflows/release-browser-agent.yml` - Browser agent builds |
| 175 | +- `.github/workflows/release-local-agent.yml` - Local agent builds |
| 176 | + |
| 177 | +## Support |
| 178 | + |
| 179 | +For issues with the release process: |
| 180 | +1. Check GitHub Actions logs |
| 181 | +2. Review this documentation |
| 182 | +3. Open an issue in the repository |
0 commit comments