GitHub ActionsでRustのincremental buildを使えるようにした
Shotaro Tsujiはじめに
自分がGitHubで公開しているRustプロジェクトのCIにかかる時間を短縮したかったので、rustcが生成するオブジェクトをキャッシュしてincremental buildが使えるようにした。当初は約3分かかっていたのが、incremental buildができるようにしてからは約50秒で終わるようになった。
参考文献
上記記事を参考にワークフローの設定を変更した。
Shotaro Tsuji
.github/workflows/rust.ymlの編集
まずは@actions/cacheが必要になる。このアクションはパターンに該当するパスのファイルを一つにまとめて圧縮してからどこかのデータストアに保存するようである。
@actions/cacheのexampleにあるYAMLをそのままコピーしただけだが、下のように追記した。
ここで、keyという値を設定しているが、これはキャッシュの取得・保存を行う際に必要になる。一連のオブジェクトファイルを特定するためにロックファイルCargo.lockのハッシュ値をキーの一部に含める。したがって、Cargo.lockがリポジトリに存在しなければならない。
Shotaro Tsuji
git-restore-mtimeの設定
上記の参考文献ではgit-restore-mtimeというスクリプトでファイルのmodified timeを生成することでincremental buildができるようにしていた。現在、このスクリプトはGitHub Actionsのアクションとして提供されている。
これを使うのは簡単で、@actions/cacheの前にusesを宣言すれば良い。
さいごに
これでincremental buildが使えるようになるが、初回ビルドではキャッシュが存在しないのでワークフローの実行に時間がかかる。2回目以降はキャッシュをダウンロードして展開するため実行時間が短縮される。
なお、@actions/cacheのREADMEによればデータストアの容量は一つのリポジトリに対して5GBである。Rustでは小さなプログラムでも100MBほどのオブジェクトを生成し、大きなプログラムになると1GBを超えることもある。他にもキャッシュを使う場合は溢れるかもしれない。
また、一週間利用されていないキャッシュは削除されるようである。