Installation

Keine Installation nötig. Zieh das offizielle Image und führe dann Folgendes aus:

docker pull ghcr.io/semrels/semrel:latest-alpine
docker run --rm \
  -v "$(pwd):/workspace" -w /workspace \
  -e GITHUB_TOKEN="$GITHUB_TOKEN" \
  ghcr.io/semrels/semrel:latest-alpine release --dry-run

Die alpine-Variante bringt git und ca-certificates mit — alles, was semrel braucht. Sieh in der Docker-Anleitung nach, wenn du mehr über Image-Varianten und darüber erfahren willst, wie du Versionen pinnst.

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

Erfordert Go ≥ 1.22. Die Binärdatei wird in $GOPATH/bin abgelegt (normalerweise ~/go/bin).

Lade die vorgebaute Binärdatei für deine Plattform aus GitHub Releases herunter und lege sie an einen Ort in deinem $PATH:

# Linux / macOS — check the releases page for the current version
curl -L https://github.com/SemRels/semrel/releases/latest/download/semrel_linux_amd64.tar.gz \
  | tar xz semrel
mv semrel /usr/local/bin/

Der einfachste Ansatz — verwende semrel als Docker-Container-Action. Keine Go-Toolchain erforderlich, nur ein Checkout und der semrel-Schritt:

name: Release

on:
  push:
    branches: [main]

permissions:
  contents: write

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Run semrel
        uses: docker://ghcr.io/semrels/semrel:latest-action
        with:
          args: release
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Das spezielle -action-Image läuft als root, weil GitHub dies für den Zugriff einer Docker-Container-Action auf den Runner-Workspace voraussetzt. Die regulären Images bleiben Nicht-root-Images für docker run und Container-Jobs.

Oder führe semrel in einem container job aus (praktisch, wenn spätere Schritte es ebenfalls brauchen):

jobs:
  release:
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/semrels/semrel:latest-alpine
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Run semrel
        run: semrel release
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Setze das semrel-Image in deinem Release-Job — GitLab CI führt es dann als Container aus:

semrel:
  image: ghcr.io/semrels/semrel:latest-alpine
  stage: release
  rules:
    - if: $CI_COMMIT_BRANCH == "main"
  script:
    - semrel release --gitlab-dotenv semrel.env
  artifacts:
    reports:
      dotenv: semrel.env

Das dotenv-Artefakt stellt SEMREL_VERSION, SEMREL_TAG und SEMREL_CHANGELOG für Folgejobs automatisch bereit. Mehr Details findest du im CI-Outputs-Anleitung.

Installiere semrel über die Go-Toolchain, wenn du ein Setup ohne Docker bevorzugst:

- uses: actions/setup-go@v5
  with:
    go-version: '1.22'

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

- name: Run semrel
  run: semrel release
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Verwende das alpine-Image als Executor:

version: 2.1
jobs:
  release:
    docker:
      - image: ghcr.io/semrels/semrel:latest-alpine
    steps:
      - checkout
      - run:
          name: Run semrel
          command: semrel release
workflows:
  release:
    jobs:
      - release:
          filters:
            branches:
              only: main

Verwende das alpine-Image in einer deklarativen Pipeline:

// Jenkinsfile
pipeline {
  agent {
    docker {
      image 'ghcr.io/semrels/semrel:latest-alpine'
      args  '-v $HOME/.gitconfig:/root/.gitconfig:ro'
    }
  }
  stages {
    stage('Release') {
      when { branch 'main' }
      steps {
        sh 'semrel release'
      }
    }
  }
}