Zum Inhalt springen

Rust GitHub Actions Workflow-Vorlage

Zuletzt aktualisiert am

Dies ist ein lauffähiges .github/workflows/ci.yml für ein Cargo-Projekt. Es installiert die stabile Toolchain, cacht Abhängigkeiten und Build-Artefakte mit Swatinem/rust-cache und prüft anschließend die Formatierung, führt clippy aus und startet die Tests.

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' }}

env:
  CARGO_TERM_COLOR: always
  CARGO_INCREMENTAL: "0"
  RUSTFLAGS: "-D warnings"

jobs:
  check:
    runs-on: ubuntu-latest
    timeout-minutes: 30
    steps:
      - uses: actions/checkout@v4

      - uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt, clippy

      - uses: Swatinem/rust-cache@v2

      - run: cargo fmt --all -- --check
      - run: cargo clippy --all-targets --all-features
      - run: cargo test --all-features

Was die nicht offensichtlichen Teile bewirken

  • dtolnay/rust-toolchain@stable installiert eine Toolchain anhand der gewählten Referenz. @stable folgt dem stabilen Release; mit Referenzen wie @1.85.0 fixieren Sie eine exakte Version.
  • Swatinem/rust-cache@v2 cacht ~/.cargo und das Verzeichnis target, indiziert über Cargo.lock, die Toolchain und die Manifestdateien. Vor dem Speichern werden veraltete Artefakte entfernt, damit der Cache nicht unbegrenzt wächst. Siehe Cargo-Caching in CI.
  • CARGO_INCREMENTAL: "0" deaktiviert die inkrementelle Kompilierung. Das hilft bei lokalen Builds, macht CI-Caches aber größer und langsamer beim Wiederherstellen.
  • RUSTFLAGS: "-D warnings" behandelt jede Compiler-Warnung in der CI als Fehler. Es verändert zudem die Compiler-Flags, daher werden Cache-Einträge eines Builds ohne diese Einstellung nicht wiederverwendet. Setzen Sie sie überall gleich.
  • cargo fmt --all -- --check schlägt fehl, wenn der Code nicht formatiert ist, und verändert dabei keine Dateien.
  • --all-targets sorgt dafür, dass clippy auch Tests, Beispiele und Benchmarks prüft.
  • 30 Minuten Timeout. Kalte Rust-Builds sind langsam, daher ist das Limit höher als bei anderen Vorlagen.

Varianten

Build-Matrix

Für Bibliotheken fügen Sie einen Job mit matrix.toolchain: [stable, beta, "1.80.0"] hinzu, um die minimal unterstützte Rust-Version zu prüfen. Siehe Matrix-Builds.

Workspaces

Ergänzen Sie --workspace bei den clippy- und Testbefehlen, um alle Mitgliedscrates abzudecken. Verwenden Sie die Eingabe workspaces: von rust-cache, wenn wenn das Workspace-Stammverzeichnis nicht dem Repository-Stammverzeichnis entspricht.

Datenbanktests

Fügen Sie einen services:-Block hinzu, wie in der Django-Vorlage gezeigt, und übergeben Sie DATABASE_URL.

Release-Builds

Fügen Sie einen Job hinzu, der cargo build --release ausführt, und laden Sie das Binary als Artefakt hoch. Cross-Kompilierung gelingt mit cross oder cargo-zigbuild einfacher.

macOS oder Windows

Nehmen Sie sie in die Matrix auf, wenn Sie Binaries für diese Plattformen ausliefern.

Auf schnelleren Maschinen ausführen

Die Kompilierzeit von Rust skaliert mit der Anzahl der Kerne, daher gehört dieser Stack zu denen, die am meisten profitieren. Ä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 React- und Rust-(Axum-)App von 2m37s auf 1m45s; siehe Benchmarks. Optimierungstipps finden Sie unter Rust und Cargo auf GitHub Actions beschleunigen, die Preise unter Preise.

FAQ

Brauche ich zusätzlich sccache?

Zunächst nicht. rust-cache übernimmt die Abhängigkeiten. sccache lohnt sich, wenn viele Projekte kompilierten Code gemeinsam nutzen.

Warum wächst mein Cache immer weiter?

rust-cache entfernt alte Artefakte, jedoch nur im eigenen Cache. Prüfen Sie die Cache-Limits, wenn Sie die Obergrenze des Repositorys erreichen.

Soll clippy den Build fehlschlagen lassen?

Ja, auf main. Bei Pull Requests verhindert es, dass sich Stil-Schulden anhäufen.

Kann ich branchenübergreifend cachen?

Branches können Caches vom Default-Branch wiederherstellen. Stellen Sie sicher, dass main den Workflow ausführt, damit dort ein Cache gespeichert wird.