Update docs

This commit is contained in:
JY Tan
2025-12-19 21:07:55 -08:00
parent b16f76e7b7
commit 10c571e7d9
3 changed files with 39 additions and 17 deletions

View File

@@ -123,19 +123,25 @@ Releases are automated using [GoReleaser](https://goreleaser.com/) via GitHub Ac
#### Creating a release
1. Tag the commit with a semantic version:
Use the release script to create and push a new version tag:
```bash
git tag v1.0.0
git push origin v1.0.0
```
```bash
# Patch release (v1.0.0 → v1.0.1)
./scripts/release.sh patch
2. GitHub Actions will automatically:
- Build binaries for all supported platforms
- Create archives with README, LICENSE, and ARCHITECTURE.md
- Generate checksums
- Create a GitHub release with changelog
- Upload all artifacts
# Minor release (v1.0.0 → v1.1.0)
./scripts/release.sh minor
```
The script runs preflight checks, calculates the next version, and prompts for confirmation before tagging.
Once the tag is pushed, GitHub Actions will automatically:
- Build binaries for all supported platforms
- Create archives with README, LICENSE, and ARCHITECTURE.md
- Generate checksums
- Create a GitHub release with changelog
- Upload all artifacts
#### Supported platforms