Laravel GitHub Actions Workflow-Vorlage
Zuletzt aktualisiert am
Dies ist eine funktionierende .github/workflows/ci.yml für eine Laravel-App, getestet gegen MySQL. Sie installiert PHP mit setup-php, cacht Composer-Downloads, erstellt die .env, führt die Datenbankmigrationen aus und startet Pint sowie die Testsuite.
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:
mysql:
image: mysql:8.0
env:
MYSQL_ROOT_PASSWORD: root
MYSQL_DATABASE: laravel_test
ports:
- 3306:3306
options: >-
--health-cmd "mysqladmin ping -h 127.0.0.1 -proot"
--health-interval 5s
--health-timeout 5s
--health-retries 20
env:
APP_ENV: testing
DB_CONNECTION: mysql
DB_HOST: 127.0.0.1
DB_PORT: 3306
DB_DATABASE: laravel_test
DB_USERNAME: root
DB_PASSWORD: root
steps:
- uses: actions/checkout@v4
- uses: shivammathur/setup-php@v2
with:
php-version: "8.3"
extensions: mbstring, pdo_mysql, bcmath
coverage: none
- name: Get Composer cache directory
id: composer-cache
run: echo "dir=$(composer config cache-files-dir)" >> "$GITHUB_OUTPUT"
- uses: actions/cache@v4
with:
path: ${{ steps.composer-cache.outputs.dir }}
key: composer-${{ runner.os }}-${{ hashFiles('composer.lock') }}
restore-keys: |
composer-${{ runner.os }}-
- run: composer install --no-interaction --prefer-dist --no-progress
- run: cp .env.example .env
- run: php artisan key:generate
- run: vendor/bin/pint --test
- run: php artisan migrate --force
- run: php artisan test --parallel
Was die nicht offensichtlichen Teile bewirken
shivammathur/setup-php@v2installiert die von Ihnen angegebene PHP-Version und die Erweiterungen.coverage: nonedeaktiviert Xdebug und PCOV, wodurch Tests schneller laufen. Setzen Siecoverage: pcovnur, wenn Sie Coverage erfassen.- Die Composer-Cache-Schritte speichern Composers Download-Cache, nicht
vendor/. Das Verzeichnis wird direkt von Composer abgefragt, sodass der Pfad auf jedem Runner stimmt. Der Schlüssel ist der Hash voncomposer.lock. - MySQL-Health-Check verwendet
127.0.0.1und das Root-Passwort. MySQL braucht einige Sekunden zum Initialisieren, daher verhindert die hohe Anzahl an Wiederholungen frühe Verbindungsfehler. DB_HOST: 127.0.0.1ist bewusst gewählt. Beilocalhostversucht der MySQL-Treiber von PHP einen Unix-Socket, der nicht existiert, und schlägt fehl.cp .env.example .envundkey:generateversorgen die App mit einer gültigen Umgebung und einemAPP_KEY, ohne echte Geheimnisse zu verwenden.pint --testmeldet Stilprobleme, ohne Dateien umzuschreiben. So schlägt die CI fehl, statt Fehler stillschweigend zu korrigieren.artisan test --parallelbenötigt das Paketbrianium/paratestund legt pro Prozess eine Datenbank an. Entfernen Sie das Flag, wenn Sie es nicht verwenden.
Varianten
PHP-Versionsmatrix
Fügen Sie matrix.php: ["8.2", "8.3", "8.4"] hinzu und verwenden Sie ${{ matrix.php }}. Behalten Sie die Anführungszeichen bei den Versionen bei. Siehe Matrix-Builds.
Frontend-Assets
Fügen Sie actions/setup-node@v4 mit cache: npm hinzu, dann vor den Tests npm ci und npm run build, falls Feature-Tests Vite-Assets rendern.
Postgres oder SQLite
Ersetzen Sie den Service durch postgres:16 mit pg_isready und setzen Sie DB_CONNECTION: pgsql. In-Memory-SQLite benötigt keinen Service und ist schneller, verdeckt aber Unterschiede zwischen den Datenbank-Engines.
Deploy-Job
Fügen Sie einen zweiten Job mit needs: test nur für main hinzu und nutzen Sie für den Cloud-Zugriff OIDC.
Auf schnelleren Maschinen ausführen
Ä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 auf Ihren ursprünglichen Runner. Parallele Tests nutzen die zusätzlichen Kerne gut aus. Siehe Laravel auf GitHub Actions beschleunigen und Preise.
FAQ
Sollte ich das vendor-Verzeichnis cachen?
Cachen Sie stattdessen den Download-Cache von Composer. composer install aus einem warmen Cache ist schnell und stimmt immer mit composer.lock überein.
Warum lehnt MySQL Verbindungen zu Beginn ab?
Der Dienst startet noch. Behalten Sie den Health-Check bei und verwenden Sie 127.0.0.1.
Wie führe ich Dusk-Browsertests aus?
Dusk benötigt Chrome und einen laufenden App-Server. Führen Sie ihn in einem separaten Job aus, damit langsame Browsertests die Unit-Tests nicht verzögern, und laden Sie Screenshots als Artefakt hoch.
Kann ich Sail in der CI verwenden?
Ja, aber es erhöht die Startzeit durch Docker. Einfaches setup-php plus Service-Container ist in der Regel schneller.
Verwandt
- Laravel in GitHub Actions beschleunigenLaravel-CI in GitHub Actions beschleunigen: Composer-Cache, Pest oder PHPUnit --parallel, abgestimmter MySQL-Service und Vite-Builds. Fertige YAML zum Kopieren.
- .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.