act を使いローカルPC 上でGitHub Actions のワークフローをテストする

# WinGetをインストールする
winget install nektos.act

# WinGetのインストール確認を行う
act --version

# ./.github/workflows配下にあるワークフローを実行する
# 実行するとLarge、Medium、Microと実行するサイズを確認するため任意のサイズを選択する
act

[Echo sample/echo] ⭐ Run Set up job
[Echo sample/echo] 🚀  Start image=node:16-buster-slim
[Echo sample/echo]   🐳  docker pull image=node:16-buster-slim platform= username= forcePull=true
[Echo sample/echo] using DockerAuthConfig authentication for docker pull
[Echo sample/echo]   🐳  docker create image=node:16-buster-slim platform= entrypoint=["tail" "-f" "/dev/null"] cmd=[] network="host"
[Echo sample/echo]   🐳  docker run image=node:16-buster-slim platform= entrypoint=["tail" "-f" "/dev/null"] cmd=[] network="host"
[Echo sample/echo]   🐳  docker exec cmd=[node --no-warnings -e console.log(process.execPath)] user= workdir=
[Echo sample/echo]   ✅  Success - Set up job
[Echo sample/echo] unable to get git ref: reference not found
[Echo sample/echo] unable to get git revision: reference not found
[Echo sample/echo] unable to get git ref: reference not found
[Echo sample/echo] unable to get git revision: reference not found
[Echo sample/echo] unable to get git ref: reference not found
[Echo sample/echo] unable to get git revision: reference not found
[Echo sample/echo] unable to get git ref: reference not found
[Echo sample/echo] unable to get git revision: reference not found
[Echo sample/echo] unable to get git ref: reference not found
[Echo sample/echo] unable to get git revision: reference not found
[Echo sample/echo] unable to get git ref: reference not found
[Echo sample/echo] unable to get git revision: reference not found
[Echo sample/echo] ⭐ Run Main Echo message
[Echo sample/echo] unable to get git ref: reference not found
[Echo sample/echo] unable to get git revision: reference not found
[Echo sample/echo] unable to get git ref: reference not found
[Echo sample/echo] unable to get git revision: reference not found
[Echo sample/echo] unable to get git ref: reference not found
[Echo sample/echo] unable to get git revision: reference not found
[Echo sample/echo] unable to get git ref: reference not found
[Echo sample/echo] unable to get git revision: reference not found
[Echo sample/echo]   🐳  docker exec cmd=[bash -e /var/run/act/workflow/0] user= workdir=
| This is a test workflow!!
[Echo sample/echo]   ✅  Success - Main Echo message [82.9863ms]
[Echo sample/echo] ⭐ Run Complete job
[Echo sample/echo] Cleaning up container for job echo
[Echo sample/echo] unable to get git ref: reference not found
[Echo sample/echo] unable to get git revision: reference not found
[Echo sample/echo]   ✅  Success - Complete job
[Echo sample/echo] 🏁  Job succeeded

# ワークフローの一覧を表示する
act -l

Stage  Job ID     Job name   Workflow name  Workflow file  Events
0      echo       echo       Echo sample    echo.yml       pull_request
0      test-job1  test-job1  test workflow  test.yaml      workflow_dispatch
1      test1      test1      Echo sample    echo.yml       pull_request
2      test2      test2      Echo sample    echo.yml       pull_request

# 特定のワークフローファイルを指定してワークフローを実行する
act -W .github/workflows/<実行したいワークフローファイル>

# 特定のジョブを指定してワークフローを実行する
act -W .github/workflows/<実行するワークフローファイル名> -j <実行するジョブID>

# 特定のイベントを指定してワークフローを実行する
act pull_request

{
  "pull_request": {
    "number": 42,
    "state": "open",
    "title": "Add new feature",
    "body": "This PR adds a new feature.",
    "head": {
      "ref": "test",
      "sha": "abc123def456"
    },
    "base": {
      "ref": "main",
      "sha": "789ghi012jkl"
    }
  },
  "repository": {
    "full_name": "Organization/acttest",
    "name": "acttest",
    "owner": {
      "login": "Organization"
    }
  },
  "action": "opened"
}

# イベントファイルを指定してactを実行する
act -W .github/workflows/test.yaml -e .github/workflows/event.json

on: push
jobs:
  deploy:
    if: ${{ !github.event.act }} # skip during local actions testing
    runs-on: ubuntu-latest
    steps:
    - run: exit 0

{
  "act": true
}

- name: Notify Slack channel
  if: ${{ !env.ACT }}
  run: |
    <Slackチャネルに通知する処理>

# input値を指定してワークフローを実行する
# 複数の変数を指定する場合は--inputを複数使用する
act -W .github/workflows/echo.yml --input environment=dev

{
  "inputs": {
    "environment": "dev",
    "ref": "main"
  }
}

# inputを指定してワークフローを実行する
act -W .github/workflows/test.yaml -e .github/workflows/event.json

name: matrix-with-user-inclusions
on: push
jobs:
  build:
    name: Matrix
    runs-on: ubuntu-latest
    steps:
      - run: echo ${NODE_VERSION}
        env:
          NODE_VERSION: ${{ matrix.node }}
    strategy:
      matrix:
        os: [ubuntu-20.04, ubuntu-22.04]
        node: [16, 18, 20]
        include:
          - os: ubuntu-20.04
            node: 16

# 特定のマトリクスのみ指定しワークフローを実行する
# この場合os:ubuntu-20.04とnode:18のケースのみ実行される
act -W .github/workflows/matrix.yml --matrix os:ubuntu-20.04 --matrix node:18

# コマンド実行時に変数を指定し実行する
# 複数の変数を指定する場合は--varを複数使用する
act -W .github/workflows/echo.yml --var SAMPLE_ENV=testvalue

# コマンド実行時にシークレットを指定する
# 複数の変数を指定する場合は-sを複数使用する
act -W .github/workflows/echo.yml -s SAMPLE_SECRET=********

SAMPLE_ENV=hello
ANOTHER_ENV=world

# 変数のファイルを指定してワークフローを実行する
act -W .github/workflows/echo.yml --var-file .github/workflows/.vars

# シークレットのファイルを指定してワークフローを実行する
act -W .github/workflows/echo.yml --secret-file .github/workflows/.secrets

# GITHUB_TOKENをシークレットで渡しワークフローを実行する
act -s GITHUB_TOKEN="$(gh auth token)"

# ワークフロー内のジョブをグラフ化する
act -g 

time="2025-10-10T23:50:37+09:00" level=info msg="Using docker host 'npipe:////./pipe/docker_engine', and daemon socket 'npipe:////./pipe/docker_engine'"
 ╭──────╮
 │ echo     │
 ╰──────╯
    ⬇
 ╭───────╮
 │ test1      │
 ╰───────╯
    ⬇
 ╭───────╮
 │ test2      │
 ╰───────╯

# actのhelpを表示する
act -h

--container-architecture=linux/amd64

# actで実行するubuntu-latestをUbuntu 24.04にして実行する
act -P ubuntu-latest=catthehacker/ubuntu:act-24.04

# コンテナイメージのPullを無効化する
act --pull=false

# オフラインモードを設定する
act --action-offline-mode