Installation

Prerequisites

Git ≥ 2.30
A repository that uses Conventional Commits

Install

go install github.com/GoSemantics/semrel/cmd/semrel@latest

Requires Go ≥ 1.22. The binary is placed in $GOPATH/bin (usually ~/go/bin).

Download the pre-built binary for your platform from GitHub Releases and place it somewhere on your $PATH:

# Linux / macOS (example for v0.1.0, amd64)
curl -L https://github.com/GoSemantics/semrel/releases/download/v0.1.0/semrel_linux_amd64 \
  -o /usr/local/bin/semrel
chmod +x /usr/local/bin/semrel

git clone https://github.com/GoSemantics/semrel.git
cd semrel
go build -o semrel ./cmd/go-semrel
mv semrel /usr/local/bin/

Verify

semrel --version

Expected output:

semrel version v0.1.0

CI / CD

For GitHub Actions, add a setup step before calling semrel release:

- name: Set up Go
  uses: actions/setup-go@v5
  with:
    go-version: '1.22'

- name: Install semrel
  run: go install github.com/GoSemantics/semrel/cmd/semrel@latest

Shell completion

Auto-completion scripts can be generated for bash, zsh, fish, and PowerShell:

# bash
semrel completion bash > /etc/bash_completion.d/semrel

# zsh
semrel completion zsh > "${fpath[1]}/_semrel"

# fish
semrel completion fish | source