コンテンツへスキップ

Rust GitHub Actions ワークフローテンプレート

最終更新

これはCargoプロジェクト向けの、そのまま動作する.github/workflows/ci.ymlです。安定版ツールチェーンをインストールし、Swatinem/rust-cacheで依存関係とビルド成果物をキャッシュしたうえで、フォーマットの確認、clippyの実行、テストの実行を行います。

ワークフロー

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

分かりにくい部分の役割

  • dtolnay/rust-toolchain@stableは、指定したrefに従ってツールチェーンをインストールします。@stableは安定版リリースに追従します。特定のバージョンに固定する場合は、@1.85.0のような形式のrefを使用してください。
  • Swatinem/rust-cache@v2は、Cargo.lock、ツールチェーン、マニフェストファイルをキーとして、~/.cargoとtargetディレクトリをキャッシュします。保存前に古い成果物も削除するため、キャッシュが際限なく肥大化することを防ぎます。詳細はCIでのCargoキャッシュを参照してください。
  • CARGO_INCREMENTAL: "0"は増分コンパイルを無効にします。ローカルでの再ビルドには有効ですが、CIではキャッシュサイズが大きくなり、復元にも時間がかかるため無効にしています。
  • RUSTFLAGS: "-D warnings"は、CIでコンパイラの警告をすべてエラーとして扱います。また、コンパイルフラグも変更されるため、このオプションなしでビルドしたキャッシュエントリは再利用されません。すべての環境で同じ設定を維持してください。
  • cargo fmt --all -- --checkは、ファイルを変更せずに、フォーマットされていないコードがあれば失敗させます。
  • --all-targetsを指定すると、clippyはテスト、examples、benchesも対象にリントを実行します。
  • タイムアウトは30分です。Rustのコールドビルドは時間がかかるため、他のテンプレートより上限を長めに設定しています。

バリエーション

ビルドマトリックス

ライブラリの場合、matrix.toolchain: [stable, beta, "1.80.0"]を指定したジョブを追加すると、サポート対象の最小Rustバージョンを確認できます。詳細はマトリックスビルドを参照してください。

ワークスペース

clippyとテストのコマンドに--workspaceを追加すると、すべてのメンバークレートを対象にできます。ワークスペースのルートがリポジトリのルートではない場合は、rust-cacheのworkspaces:入力を使用してください。

データベースのテスト

Djangoテンプレートに示されているようにservices:ブロックを追加し、DATABASE_URLを渡してください。

リリースビルド

cargo build --releaseを実行し、バイナリをアーティファクトとしてアップロードするジョブを追加します。クロスコンパイルはcrossまたはcargo-zigbuildを使うと簡単です。

macOS または Windows

これらのターゲット向けにバイナリを配布する場合は、マトリックスに追加してください。

より高速なマシンで実行する

Rustのコンパイル時間はコア数に比例するため、このスタックは最も恩恵を受けやすいものの一つです。次の1行を変更してください:

    runs-on: [self-hosted, Linux, compiler-ci]

このジョブは、compiler.devの8 vCPUの新しいマシンで実行され、自動的にフォールバックします。compiler.devのベンチマークでは、ReactとRust(Axum)のアプリが2m37sから1m45sに短縮されました。詳細はベンチマークを参照してください。高速化のヒントはGitHub ActionsでRustとCargoを高速化する方法にあり、料金は料金プランのページで確認できます。

よくある質問

sccacheも必要ですか?

最初は必要ありません。rust-cacheが依存関係を扱います。sccacheは、多くのプロジェクトでコンパイル済みコードを共有する場合に役立ちます。

キャッシュが増え続けるのはなぜですか?

rust-cacheは古い成果物を削除しますが、それは自身のキャッシュに対してのみです。リポジトリの上限に達した場合はキャッシュの制限を確認してください。

clippyでビルドを失敗させるべきですか?

mainではそうすることをお勧めします。プルリクエストでは、スタイルの負債が蓄積するのを防ぐのに役立ちます。

ブランチをまたいでキャッシュを共有できますか?

ブランチはデフォルトブランチのキャッシュを復元できます。キャッシュを保存するため、必ずmainでワークフローが実行されるようにしてください。