Releases
Create a normal release from main:
./scripts/release.sh 1.2.3
Attach curated release notes to the GitHub release:
./scripts/release.sh 1.2.3 --notes release-notes.md
The release script stores notes verbatim in the annotated git tag, including markdown headings.
The GitHub release workflow uses release notes in this order:
- Manual
release_notesinput fromworkflow_dispatch. - Annotated tag message from
scripts/release.sh --notes. - Generated commit log since the previous tag.
Release checklist
Before tagging:
- Run the Go test suite.
- Build the docs site with
bun run buildfromdocs/. - Confirm release notes describe user-facing behavior, migrations, and image tags.
- Create the annotated tag with
scripts/release.sh.
Binary Assets
Each release publishes standalone binaries for Linux, macOS, and Windows. Use these when deploying Orisun directly as a process instead of through Docker.
| Asset pattern | Backend |
|---|---|
orisun-<os>-<arch> | All backends |
orisun-pg-<os>-<arch> | PostgreSQL only |
orisun-sqlite-<os>-<arch> | SQLite only |
Linux and macOS binaries should be marked executable after download:
chmod +x ./orisun-sqlite
Docker Tags
| Tag | Backend |
|---|---|
orexza/orisun:latest | All backends |
orexza/orisun:pg | PostgreSQL only |
orexza/orisun:sqlite | SQLite only |
orexza/orisun:<version> | All backends for a release version |
orexza/orisun:<version>-pg | PostgreSQL-only release version |
orexza/orisun:<version>-sqlite | SQLite-only release version |