Go GitHub Actions Workflow-Vorlage
Zuletzt aktualisiert am
Dies ist ein funktionierendes .github/workflows/ci.yml für ein Go-Modul. Es liest die Go-Version aus go.mod, cacht Module und Build-Ausgaben, führt go vet, golangci-lint und die Tests mit dem Race-Detector aus.
Der Workflow
name: CI
on:
push:
branches: [main]
pull_request:
permissions:
contents: read
concurrency:
group: ci-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
jobs:
lint:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version-file: go.mod
- run: go vet ./...
- uses: golangci/golangci-lint-action@v8
with:
version: latest
test:
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache-dependency-path: go.sum
- run: go build ./...
- run: go test -race -count=1 -coverprofile=coverage.out ./...
Was die nicht offensichtlichen Teile bewirken
go-version-file: go.modverwendet die Version, die Ihr Modul deklariert. So folgt die CI dergo-Anweisung, ohne dass Sie an einer zweiten Stelle etwas aktualisieren müssen.- Caching läuft automatisch.
setup-goab v4 cacht den Modul-Download-Cache und den Build-Cache, geschlüsselt übergo.sum. Deshalb ist kein eigeneractions/cache-Schritt nötig.cache-dependency-pathwird nur benötigt, wenngo.sumnicht im Repository-Stammverzeichnis liegt, etwa in einem Monorepo. - Zwei Jobs. Lint und Tests laufen parallel auf getrennten Maschinen. Sie erhalten so das schnellere der beiden Ergebnisse als erste Rückmeldung, die Gesamtzeit entspricht dem langsameren.
golangci-lint-actionverwaltet seinen eigenen Cache und annotiert den Diff. Fixieren Sie eine Lint-Version stattlatest, wenn Sie reproduzierbare Ergebnisse brauchen. Prüfen Sie vor dem Kopieren die README der Action auf die aktuelle Hauptversion.go test -raceaktiviert den Race-Detector. Er verlangsamt die Tests und benötigt mehr Speicher, findet aber echte Nebenläufigkeitsfehler. Entfernen Sie ihn nur, wenn es unbedingt sein muss, und probieren Sie ihn zuerst aus.-count=1deaktiviert das Caching von Testergebnissen in Go. Ergebnisse werden nur pro Maschine gecacht, auf frischen CI-Runnern macht das also keinen Unterschied. Es sorgt aber dafür, dass die Läufe identisch zu lokalen-count=1-Läufen bleiben.
Varianten
Versionsmatrix
Fügen Sie matrix.go: ["1.23", "1.24"] hinzu und verwenden Sie go-version: ${{ matrix.go }} anstelle von go-version-file. Das ist nur für Bibliotheken nötig; Anwendungen sollten die Version testen, die sie ausliefern. Siehe Matrix-Builds.
Datenbanktests
Fügen Sie einen services:-Block hinzu. Die Django-Vorlage zeigt einen Postgres-Service mit Health-Checks, und derselbe Block funktioniert auch für Go.
Monorepo
Verwenden Sie working-directory: und einen paths:-Filter und verweisen Sie cache-dependency-path auf die go.sum jedes Moduls.
Build und Release
Fügen Sie einen Job hinzu, der go build -trimpath -ldflags="-s -w" ausführt und die Binärdatei als Artefakt hochlädt, oder nutzen Sie bei Tags GoReleaser.
macOS oder Windows
Nehmen Sie diese in eine Matrix auf, wenn Sie Binärdateien für diese Systeme ausliefern.
Auf schnelleren Maschinen ausführen
Go kompiliert und testet parallel, daher helfen zusätzliche Kerne direkt. Ändern Sie in jedem Job eine Zeile:
runs-on: [self-hosted, Linux, compiler-ci]
Der Job läuft auf einer frischen Maschine mit 8 vCPU von compiler.dev, mit Rückfall auf Ihren ursprünglichen Runner. In compiler.dev's Benchmark einer React- und Go-App mit go test -race sank die Laufzeit von 6m13s auf 2m42s; siehe Benchmarks. Mehr dazu unter Go auf GitHub Actions beschleunigen und bei Preise.
FAQ
Brauche ich actions/cache für Go-Module?
Mit setup-go ab v4 nicht. Es cacht Module und Build-Ausgaben standardmäßig.
Warum ist der erste Lauf langsam und spätere Läufe sind schnell?
Der erste Lauf füllt den Build-Cache. Spätere Läufe verwenden die kompilierten Pakete erneut.
Sollte ich den Race-Detector bei jedem Push ausführen?
Wenn es in Ihr Zeitbudget passt, ja. Wenn nicht, führen Sie ihn auf main und nächtlich aus.
Wie verhindere ich, dass Lint bei altem Code fehlschlägt?
Setzen Sie only-new-issues: true in der Lint-Action.
Verwandt
- .NET GitHub Actions Workflow-VorlageFertige GitHub-Actions-CI für .NET mit NuGet-Cache, Restore-, Build- und Test-Schritten, optionalem SQL-Server-Dienst, Concurrency und Berechtigungen.
- Django GitHub Actions Workflow-VorlageFertige GitHub-Actions-CI für Django mit Postgres-Service-Container, pip-Caching, Migrationsprüfung und Tests sowie Concurrency und Berechtigungen.
- Docker Build GitHub Actions Workflow VorlageFertiger GitHub-Actions-Workflow zum Bauen von Docker-Images mit Buildx, GitHub-Cache-Layern und einem Push zu GHCR auf main, mit minimalen Berechtigungen.
- Elixir GitHub Actions Workflow-VorlageFertige GitHub-Actions-CI für Elixir und Phoenix mit Postgres-Service, Caching von deps und _build über erlef/setup-beam sowie Formatierung und Tests.