|
| 1 | +--- |
| 2 | +description: Upload release packages to GitHub Releases |
| 3 | +--- |
| 4 | + |
| 5 | +# Upload Packages to GitHub Releases |
| 6 | + |
| 7 | +Upload built packages to GitHub Releases page for distribution. |
| 8 | + |
| 9 | +## Prerequisites |
| 10 | +- All packages built and available in `release/` directory |
| 11 | +- GitHub CLI installed (`brew install gh`) and authenticated (`gh auth login`) |
| 12 | + |
| 13 | +## Packages to Upload |
| 14 | +- `GlotShot-{version}-arm64.dmg` - macOS Apple Silicon |
| 15 | +- `GlotShot-{version}-x64.exe` - Windows x64 |
| 16 | +- `GlotShot-{version}-arm64.exe` - Windows ARM64 |
| 17 | +- `GlotShot-{version}-x86_64.AppImage` - Linux x64 |
| 18 | +- `GlotShot-{version}-arm64.AppImage` - Linux ARM64 |
| 19 | + |
| 20 | +## Upload Process |
| 21 | + |
| 22 | +### 1. Create Release on GitHub |
| 23 | +```bash |
| 24 | +gh release create v{version} --title "GlotShot v{version}" --notes-file RELEASE_NOTES.md |
| 25 | +``` |
| 26 | + |
| 27 | +### 2. Upload Packages |
| 28 | +// turbo |
| 29 | +```bash |
| 30 | +gh release upload v{version} release/GlotShot-{version}-*.dmg release/GlotShot-{version}-*.exe release/GlotShot-{version}-*.AppImage --clobber |
| 31 | +``` |
| 32 | + |
| 33 | +## Release Notes Template |
| 34 | +Create `RELEASE_NOTES.md` with: |
| 35 | + |
| 36 | +```markdown |
| 37 | +# GlotShot v{version} |
| 38 | + |
| 39 | +## Downloads |
| 40 | + |
| 41 | +| Platform | Architecture | Download | |
| 42 | +|----------|--------------|----------| |
| 43 | +| macOS | Apple Silicon | GlotShot-{version}-arm64.dmg | |
| 44 | +| Windows | x64 | GlotShot-{version}-x64.exe | |
| 45 | +| Windows | ARM64 | GlotShot-{version}-arm64.exe | |
| 46 | +| Linux | x64 | GlotShot-{version}-x86_64.AppImage | |
| 47 | +| Linux | ARM64 | GlotShot-{version}-arm64.AppImage | |
| 48 | + |
| 49 | +## What's New |
| 50 | +- [List changes here] |
| 51 | + |
| 52 | +## System Requirements |
| 53 | +- macOS 11.0+ (Big Sur or later) |
| 54 | +- Windows 10+ (64-bit) |
| 55 | +- Linux: Ubuntu 20.04+ or compatible |
| 56 | +``` |
| 57 | + |
| 58 | +## Notes |
| 59 | +- **DO NOT** use `git push` for release packages (GitHub file size limit is 100MB) |
| 60 | +- Always use GitHub Releases for distributing installers |
| 61 | +- Use `--clobber` flag to replace existing files when re-uploading |
0 commit comments