Elixir GitHub Actions Workflow-Vorlage
Zuletzt aktualisiert am
Dies ist eine funktionierende .github/workflows/ci.yml für eine Elixir- oder Phoenix-App mit Postgres. Sie installiert Erlang/OTP und Elixir mit erlef/setup-beam, cached deps und _build, prüft die Formatierung, kompiliert mit Warnungen als Fehlern und führt mix test 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:
test:
runs-on: ubuntu-latest
timeout-minutes: 20
services:
postgres:
image: postgres:16
env:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
ports:
- 5432:5432
options: >-
--health-cmd "pg_isready -U postgres"
--health-interval 5s
--health-timeout 5s
--health-retries 10
env:
MIX_ENV: test
DATABASE_URL: ecto://postgres:postgres@localhost:5432/app_test
steps:
- uses: actions/checkout@v4
- uses: erlef/setup-beam@v1
id: beam
with:
otp-version: "27"
elixir-version: "1.18"
- uses: actions/cache@v4
with:
path: |
deps
_build
key: mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('mix.lock') }}
restore-keys: |
mix-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-
- run: mix deps.get
- run: mix format --check-formatted
- run: mix compile --warnings-as-errors
- run: mix ecto.create && mix ecto.migrate
- run: mix test
Was die nicht offensichtlichen Teile bewirken
erlef/setup-beam@v1installiert Erlang/OTP und Elixir. Fixieren Sie beide Versionen als Strings in Anführungszeichen, damit YAML sie nicht in Zahlen umwandelt. Die Action gibt die exakt installierten Versionen aus, die der Cache-Schlüssel überid: beamverwendet.- Cache-Schlüssel mit OTP- und Elixir-Versionen. Kompilierte
_build-Ausgaben sind nur für die Versionen gültig, die sie erzeugt haben. Diese Angaben verhindern, dass Beam-Dateien einer anderen Version geladen werden. Änderungen anmix.lockerzeugen einen neuen Cache, undrestore-keysgreift für dieselben Versionen auf den neuesten Cache zurück. depsund_buildgemeinsam.depsenthält die heruntergeladenen Pakete,_builddie kompilierte Ausgabe einschließlich der Abhängigkeiten. Das Cachen beider sorgt dafür, dass spätere Läufe schnell sind. Das Kompilieren der Abhängigkeiten ist der langsamste Teil eines Kaltstarts. Siehe Elixir auf GitHub Actions beschleunigen.MIX_ENV: testauf Job-Ebene sorgt dafür, dass jeder Schritt die Test-Umgebung verwendet, sodass_build/testgecached und kompiliert wird.DATABASE_URLsetzt voraus, dassconfig/runtime.exsoderconfig/test.exssie liest. Phoenix-Generatoren verwendenecto://-URLs. Wenn Ihre Testkonfiguration den Datenbank-Host fest codiert, setzen Sie ihn auflocalhostsowie den oben genannten Benutzer und das Passwort.--warnings-as-errorslässt den Build bei Compiler-Warnungen fehlschlagen und hält so die Codebasis sauber.- Service-Health-Check. Ohne ihn könnte
ecto.createausgeführt werden, bevor Postgres Verbindungen annimmt.
Varianten
Versionsmatrix
Fügen Sie matrix.include-Paare wie otp: "26", elixir: "1.17" und otp: "27", elixir: "1.18" hinzu. Kombinieren Sie kompatible Versionen. Siehe Matrix-Builds.
Statische Analyse
Fügen Sie mix credo --strict sowie Dialyzer mit dialyxir hinzu. Cachen Sie das PLT-Verzeichnis (priv/plts) separat, mit mix.lock als Schlüssel, da der Aufbau viele Minuten dauert.
Assets
Phoenix-Apps mit esbuild und Tailwind benötigen mix assets.setup und mix assets.build, bevor Tests ausgeführt werden, die Seiten rendern.
Test-Partitionen
Mix unterstützt MIX_TEST_PARTITION mit --partitions. Kombinieren Sie dies mit Test-Sharding und verwenden Sie pro Partition eine eigene Datenbank.
Deploy-Job
Fügen Sie einen zweiten Job nur auf main hinzu, der mit mix release ein Release erstellt, es als Artefakt hochlädt und mit OIDC deployt.
Auf schnelleren Maschinen ausführen
Die BEAM führt Tests nebenläufig aus, daher helfen zusätzliche Kerne. Ändern Sie eine Zeile:
runs-on: [self-hosted, Linux, compiler-ci]
Der Job läuft auf einer frischen 8-vCPU-Maschine von compiler.dev mit automatischem Fallback. Im Benchmark von compiler.dev sank die Laufzeit einer Phoenix-LiveView-App mit Postgres von 2m07s auf 1m03s; siehe Benchmarks. Die Preise finden Sie unter Preise.
FAQ
Warum _build zusätzlich zu deps cachen?
Das Kompilieren der Abhängigkeiten ist langsam, und _build speichert die kompilierten Ergebnisse.
Kann ich die OTP-Version aus dem Cache-Schlüssel weglassen?
Das ist riskant. Beam-Dateien, die mit einer OTP-Version kompiliert wurden, lassen sich unter einer anderen möglicherweise nicht laden.
Wie finde ich kompatible OTP- und Elixir-Versionen?
Die Kompatibilitätstabelle für Elixir in der offiziellen Dokumentation listet für jedes Release die unterstützten OTP-Versionen auf.
Schadet ecto.create, wenn die Datenbank bereits existiert?
Nein. Es meldet, dass die Datenbank bereits existiert, und fährt fort.
Verwandt
- Elixir in GitHub Actions beschleunigenElixir- und Phoenix-CI in GitHub Actions beschleunigen: deps- und _build-Cache per mix.lock und OTP, mix test --partitions, Postgres-Service, Dialyzer-PLT.
- .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.