Skip to main content

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:

  1. Manual release_notes input from workflow_dispatch.
  2. Annotated tag message from scripts/release.sh --notes.
  3. Generated commit log since the previous tag.

Release checklist

Before tagging:

  1. Run the Go test suite.
  2. Build the docs site with bun run build from docs/.
  3. Confirm release notes describe user-facing behavior, migrations, and image tags.
  4. 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 patternBackend
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

TagBackend
orexza/orisun:latestAll backends
orexza/orisun:pgPostgreSQL only
orexza/orisun:sqliteSQLite only
orexza/orisun:<version>All backends for a release version
orexza/orisun:<version>-pgPostgreSQL-only release version
orexza/orisun:<version>-sqliteSQLite-only release version