act とは

actは、開発者がGitHub Actionsのワークフローをローカルで実行できるようにし、迅速なフィードバックと開発プロセスの合理化を実現します。このツールはGitHub Actions環境をエミュレートし、ユーザーがリモートリポジトリに変更をコミットしてプッシュすることなく、ワークフローをテストおよびデバッグできるようにします。GitHubで直接テストするのとは異なり、actはより速い反復サイクルを提供し、CI/CDパイプラインの待ち時間を短縮します。Dockerを活用してアクションを実行し、GitHub環境との一貫性を確保します。開発者は、より迅速なフィードバックループ、容易なデバッグ、およびVS Codeなどの好みのIDEから拡張機能を通じてアクションを直接管理および実行できるというメリットを享受できます。

act の主な機能

ローカルワークフロー実行

開発者がGitHub Actionsのワークフローをローカルで実行できるようにし、テストのためにリモートリポジトリに変更をプッシュする必要をなくします。これにより、フィードバックループが大幅に短縮され、より迅速な反復とデバッグが可能になります。GitHub Actions環境をエミュレートし、ワークフローがGitHubのサーバー上と同様にローカルで一貫して動作するようにします。

Dockerベースの実行

Dockerを活用してアクションを実行し、GitHub Actionsランタイムを反映した一貫性のある分離された環境を確保します。このアプローチにより、依存関係と構成が正しく管理され、ローカル実行とリモート実行の間の不一致が防止されます。ワークフローファイルで定義されたDockerイメージをプルまたはビルドします。

環境変数シミュレーション

リポジトリ、コミット、ランナーに関連するものを含む、GitHubの環境変数を反映したシミュレートされた環境を提供します。これにより、ワークフローがGitHubと同様の情報をローカルでアクセスできるようになり、条件付きロジックと統合の正確なテストとデバッグが容易になります。

VS Code統合

専用の拡張機能を通じてVisual Studio Codeとの統合を提供します。この統合により、開発者はエディターから直接ワークフローを実行およびテストでき、シームレスな開発エクスペリエンスを提供します。ワークフローの反復プロセスを簡素化し、コンテキストスイッチを削減します。

カスタムコンテナエンジンのサポート

ユーザーがカスタムコンテナエンジンを指定できるようにし、実行環境の管理に柔軟性を提供します。これは、特定の要件があるユーザーや、デフォルトのDockerとは異なるコンテナエンジンを使用することを好むユーザーにとって特に役立ちます。構成を通じてさまざまなコンテナエンジンをサポートします。

GitHub Enterpriseサポート

GitHub Enterpriseをサポートし、ユーザーがプライベートGitHub Enterpriseインスタンスでホストされているリポジトリのワークフローをローカルで実行できるようにします。これは、開発とCI/CDパイプラインにGitHub Enterpriseを使用している組織にとって不可欠であり、安全で制御された環境でワークフローをテストおよびデバッグできます。

act の使い方

インストール: 任意のパッケージマネージャーを使用してactをインストールします（例：macOSのHomebrewの場合はbrew install act、または他のプラットフォームについてはWebサイトの指示に従ってください）。2. リポジトリに移動: .github/workflowsディレクトリを含むGitリポジトリのルートにディレクトリを変更します。3. ワークフローを実行: コマンドact -W .github/workflows/<your_workflow_file.yml>を使用して、特定のワークフローを実行します。<your_workflow_file.yml>をワークフローの実際のファイル名に置き換えます。4. ジョブを指定: コマンドにジョブ名を追加して、ワークフロー内の特定のジョブをターゲットにします：act -W .github/workflows/<your_workflow_file.yml> -j <job_name>。5. 出力を表示: ターミナルで出力を確認します。これはGitHub Actionsランナーをシミュレートし、ログ、環境変数、および生成されたすべての成果物を含みます。6. 環境をカスタマイズ: -eフラグを使用して環境変数をアクションに渡すか、-sフラグを使用してシークレットを提供します。

act の利用シーン

ワークフローのデバッグ

ソフトウェアエンジニアは、actを使用して複雑なワークフローをローカルでデバッグできます。各アクションをステップスルーし、ログを検査し、変更をコミットせずに構成を変更できます。これにより、デバッグプロセスが加速され、リモートCI/CDパイプラインでの問題のトラブルシューティングに費やす時間が短縮されます。