mirror of
https://github.com/amiayweb/Hytale-F2P.git
synced 2026-02-26 19:31:46 -03:00
74 lines
1.7 KiB
Markdown
74 lines
1.7 KiB
Markdown
# GitHub Actions
|
|
|
|
## Build and Release Workflow
|
|
|
|
The `release.yml` workflow automatically builds the launcher for all platforms.
|
|
|
|
### Triggers
|
|
|
|
| Trigger | Builds | Creates Release |
|
|
|---------|--------|-----------------|
|
|
| Push to `main` | Yes | No |
|
|
| Push tag `v*` | Yes | Yes |
|
|
| Manual dispatch | Yes | No |
|
|
|
|
### Platforms
|
|
|
|
All builds run in parallel:
|
|
|
|
- **Linux** (ubuntu-latest): AppImage, deb
|
|
- **Windows** (windows-latest): NSIS installer, portable exe
|
|
- **macOS** (macos-latest): Universal DMG (Intel + Apple Silicon)
|
|
|
|
### Creating a Release
|
|
|
|
**⚠️ IMPORTANT: Semantic Versioning Required**
|
|
|
|
This project uses **strict semantic versioning with numerical versions only**:
|
|
- ✅ **Valid**: `2.0.1`, `2.0.11`, `2.1.0`, `3.0.0`
|
|
- ❌ **Invalid**: `2.0.2b`, `2.0.2a`, `2.0.1-beta`
|
|
|
|
**Format**: `MAJOR.MINOR.PATCH` (e.g., `2.0.11`)
|
|
|
|
The auto-update system requires semantic versioning for proper version comparison. Letter suffixes are not supported.
|
|
|
|
**Steps:**
|
|
|
|
1. Update version in `package.json` (use numerical format only, e.g., `2.0.11`)
|
|
2. Commit and push to `main`
|
|
3. Create and push a version tag:
|
|
|
|
```bash
|
|
git tag v2.0.11
|
|
git push origin v2.0.11
|
|
```
|
|
|
|
The workflow will:
|
|
1. Build all platforms in parallel
|
|
2. Upload artifacts to GitHub Release
|
|
3. Generate release notes automatically
|
|
|
|
### Build Artifacts
|
|
|
|
After each build, artifacts are available in the Actions tab for 90 days:
|
|
|
|
- `linux-builds`: `.AppImage`, `.deb`
|
|
- `windows-builds`: `.exe`
|
|
- `macos-builds`: `.dmg`, `.zip`, `latest-mac.yml`
|
|
|
|
### Local Development
|
|
|
|
Build locally for your platform:
|
|
|
|
```bash
|
|
npm run build:linux
|
|
npm run build:win
|
|
npm run build:mac
|
|
```
|
|
|
|
Or build all platforms (requires appropriate OS):
|
|
|
|
```bash
|
|
npm run build:all
|
|
```
|