Supports being called by other repositories as an action

This commit is contained in:
Tw93
2025-08-23 19:26:26 +08:00
parent 5c920cbd43
commit 34a0419c83
3 changed files with 248 additions and 0 deletions

97
README_ACTION.md Normal file
View File

@@ -0,0 +1,97 @@
# Pake GitHub Action
Transform any webpage into a lightweight desktop app with a single GitHub Actions step.
## Quick Start
```yaml
- name: Build Pake App
uses: tw93/Pake@v3
with:
url: 'https://example.com'
name: 'MyApp'
```
## Inputs
| Parameter | Description | Required | Default |
|-----------|-------------|----------|---------|
| `url` | Target URL to package | ✅ | |
| `name` | Application name | ✅ | |
| `output-dir` | Output directory | | `dist` |
| `icon` | Custom app icon URL/path | | |
| `width` | Window width | | `1200` |
| `height` | Window height | | `780` |
| `debug` | Enable debug mode | | `false` |
## Outputs
| Output | Description |
|--------|-------------|
| `package-path` | Path to the generated package |
## Examples
### Basic Usage
```yaml
name: Build Web App
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: tw93/Pake@v3
with:
url: 'https://weekly.tw93.fun'
name: 'WeeklyApp'
```
### With Custom Icon
```yaml
- uses: tw93/Pake@v3
with:
url: 'https://example.com'
name: 'MyApp'
icon: 'https://example.com/icon.png'
width: 1400
height: 900
```
### Multi-Platform Build
```yaml
jobs:
build:
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: tw93/Pake@v3
with:
url: 'https://example.com'
name: 'CrossPlatformApp'
```
## How It Works
1. **Auto Setup**: Installs Rust, Node.js dependencies, builds Pake CLI
2. **Build App**: Runs `pake` command with your parameters
3. **Package Output**: Finds and moves the generated package to output directory
## Supported Platforms
- **Linux**: `.deb` packages (Ubuntu runners)
- **macOS**: `.app` and `.dmg` packages (macOS runners)
- **Windows**: `.exe` and `.msi` packages (Windows runners)
Use GitHub's matrix strategy to build for multiple platforms simultaneously.
## Testing
Try the action with our test workflow: [test-action.yml](.github/workflows/test-action.yml)