f831fd6846
- Move PHP and Go framework docs from /packages/ to /build/ - Move CLI docs from /packages/go/cmd/ to /build/cli/ - Add /publish/ section with docs for all release publishers: GitHub, Docker, npm, Homebrew, Scoop, AUR, Chocolatey, LinuxKit - Add sidebar navigation for /publish/ section - Update nav with Build, Publish, Deploy dropdowns - Remove changelog, contributing, guide, and security sections - Make sidebar auto-discover from packages, build, publish, deploy dirs Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
78 lines
1.2 KiB
Markdown
78 lines
1.2 KiB
Markdown
# GitHub Releases
|
|
|
|
Publish releases to GitHub with binary assets, checksums, and changelog.
|
|
|
|
## Configuration
|
|
|
|
```yaml
|
|
publishers:
|
|
- type: github
|
|
```
|
|
|
|
## Options
|
|
|
|
| Option | Description | Default |
|
|
|--------|-------------|---------|
|
|
| `draft` | Create as draft release | `false` |
|
|
| `prerelease` | Mark as prerelease | `false` |
|
|
| `assets` | Additional asset patterns | Auto-detected |
|
|
|
|
## Examples
|
|
|
|
### Basic Release
|
|
|
|
```yaml
|
|
publishers:
|
|
- type: github
|
|
```
|
|
|
|
Automatically uploads:
|
|
- Built binaries from `dist/`
|
|
- SHA256 checksums
|
|
- Generated changelog
|
|
|
|
### Draft Release
|
|
|
|
```yaml
|
|
publishers:
|
|
- type: github
|
|
draft: true
|
|
```
|
|
|
|
### Prerelease
|
|
|
|
```yaml
|
|
publishers:
|
|
- type: github
|
|
prerelease: true
|
|
```
|
|
|
|
### Custom Assets
|
|
|
|
```yaml
|
|
publishers:
|
|
- type: github
|
|
assets:
|
|
- dist/*.tar.gz
|
|
- dist/*.zip
|
|
- docs/manual.pdf
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
| Variable | Description |
|
|
|----------|-------------|
|
|
| `GITHUB_TOKEN` | GitHub personal access token (required) |
|
|
|
|
## Generated Assets
|
|
|
|
For a cross-platform Go build, GitHub releases include:
|
|
|
|
```
|
|
myapp_1.0.0_linux_amd64.tar.gz
|
|
myapp_1.0.0_linux_arm64.tar.gz
|
|
myapp_1.0.0_darwin_amd64.tar.gz
|
|
myapp_1.0.0_darwin_arm64.tar.gz
|
|
myapp_1.0.0_windows_amd64.zip
|
|
checksums.txt
|
|
```
|