【GitHub】GitHub Actions リポジトリチェックアウトを高速化する方法

GitHub Actionsは、CI/CDパイプラインを簡単に構築できる強力なツールです。しかし、リポジトリのチェックアウトが遅いと、ワークフロー全体の速度に悪影響を与えることがあります。チェックアウトを高速化するための3つの方法のメモ。

浅いチェックアウト（Shallow Checkout）

浅いチェックアウトを行うことで、必要なコミット履歴のみを取得し、時間を短縮できます。これには、fetch-depthオプションを使用します。

設定方法

以下は、最新の1コミットだけを取得する設定例です：

1
2
3
4
5
6
7
8
9
jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 1  # 最新の1コミットだけを取得

この設定により、不要な履歴の取得を防ぎ、チェックアウトの速度が向上します。

特定のブランチやタグをチェックアウト

必要なブランチやタグだけをチェックアウトすることで、ムダなデータのダウンロードを防ぎます。

設定方法

以下は、特定のブランチをチェックアウトする設定例です：

1
2
3
4
5
6
7
8
9
jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout specific branch
        uses: actions/checkout@v4
        with:
          ref: refs/heads/main  # 特定のブランチを指定

この方法では、指定したブランチやタグのみが取得され、チェックアウトがより迅速に行われます。

actions/checkout の最新バージョンを使用

actions/checkoutアクションの最新バージョンを使用することで、パフォーマンスの改善や新機能を利用できます。常に最新バージョンを使用することが推奨されます。

設定方法

以下は、v4バージョンを使用する設定例です：

1
2
3
4
5
6
7
jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

最新バージョンの利用により、最新の最適化やバグ修正が反映された状態でアクションを実行できます。

まとめ

GitHub Actionsでリポジトリのチェックアウトを高速化するためには、以下の方法を試してみてください：

浅いチェックアウト：fetch-depthオプションを使用して取得するコミットを制限する。
特定のブランチやタグをチェックアウト：必要なブランチやタグのみをチェックアウトする。
最新バージョンのactions/checkoutを使用：常に最新バージョンを使用する。

これらの方法を組み合わせることで、ワークフローの効率を大幅に向上させることができます。

参考

actions/checkout