GitHub Actions｜Self-hosted Runner：CI/CD 実践ガイドで自動化効率最大化

# Workflow(Action) 名称
name: Pull Reqeust Automation

# Actions ログのタイトル名
run-name: "[Pull Reqeust Automation] ${{ github.event.pull_request.title \\|\\| github.ref }}"

# トリガーイベント
on:
  # PRイベント
  pull_request:
    # PR - オープン、再オープン、新しいPushコミット時
    types: [opened, synchronize, reopened]


# 同じ Concurrency Group に新しい Job が来た場合、実行中のジョブをキャンセル
# 例：Pushコミットでトリガーされたジョブが実行前に再度Pushされた場合、前のジョブをキャンセル
concurrency:
  group: ${{ github.workflow }}-${{ github.ref_name }}
  cancel-in-progress: true

# Job 作業項目
# Job は並行実行される
jobs:
  # Job ID
  label-pr-by-file-count:
    # Job 名称（省略可、ログ表示を分かりやすくするため設定推奨）
    name: Label PR by changes file count

    # このJobが失敗してもWorkflow全体には影響せず他のJobを継続
    continue-on-error: true
    
    # 最大タイムアウト時間を設定し、異常時の無限待機を防止
    timeout-minutes: 10

    # Runnerラベル - GitHub Hosted Runner ubuntu-latest を使用して作業を実行
    # Privateリポジトリの場合は使用量に応じて課金される可能性あり
    runs-on: ubuntu-latest

    # 作業ステップ
    # ステップは順番に実行される
    steps:
      # ステップ名
      - name: Get changed file count and apply label
        # ステップID（省略可、出力を参照しない場合は不要）
        id: get-changed-files-count-by-gh
        # 外部環境パラメータを実行時に注入
        env:
          # secrets.GITHUB_TOKEN はGitHub Actions実行時に自動生成されるトークンで、Secretsに設定不要。GitHubリポジトリAPIの一部スコープ権限を持つ
          # https://docs.github.com/en/actions/how-tos/security-for-github-actions/security-guides/use-github_token-in-workflows
          # gh(GitHub) CLI はGH_TOKENを環境変数に注入しないと操作権限がない
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        # Shellスクリプト
        # GitHub Hosted Runner には gh CLI が標準インストールされており、追加インストール不要で使用可能
        run: \\|
          #   ${{ github.xxx }} はGitHub Actionsのコンテキスト式
          #   シェル変数ではなく、YAML解析時にGitHub Actionsが対応する値に置換
          #   他のパラメータ：https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
          
          # PR番号を取得:
          PR_NUMBER=${{ github.event.pull_request.number }}

          # リポジトリを取得:
          REPO=${{ github.repository }}

          # GitHub API(gh CLI)を使って変更ファイル数を取得
          FILE_COUNT=$(gh pr view $PR_NUMBER --repo $REPO --json files --jq '.files \\| length')
          
          # ログ出力
          echo "Changed file count: $FILE_COUNT"

          # ラベル付けロジック
          if [ "$FILE_COUNT" -lt 5 ]; then
            LABEL="XS"
          elif [ "$FILE_COUNT" -lt 10 ]; then
            LABEL="S"
          elif [ "$FILE_COUNT" -lt 30 ]; then
            LABEL="M"
          elif [ "$FILE_COUNT" -lt 80 ]; then
            LABEL="L"
          elif [ "$FILE_COUNT" -lt 200 ]; then
            LABEL="XL"
          else
            LABEL="XXL"
          fi

          # GitHub API(gh CLI)で現在のサイズラベルを削除
          EXISTING_LABELS=$(gh pr view "$PR_NUMBER" --repo "$REPO" --json labels --jq '.labels[].name')
          for EXISTING in $EXISTING_LABELS; do
            case "$EXISTING" in
              XS\\|S\\|M\\|L\\|XL\\|XXL)
                echo "🧹 既存ラベルを削除: $EXISTING"
                gh pr edit "$PR_NUMBER" --repo "$REPO" --remove-label "$EXISTING"
                ;;
            esac
          done

          # （任意）ラベルが存在しなければ作成
          if ! gh label list --repo "$REPO" \\| grep -q "^$LABEL"; then
            echo "🆕 ラベル作成: $LABEL"
            gh label create "$LABEL" --repo "$REPO" --description "Size label: $LABEL" --color "ededed"
          else
            echo "✅ ラベル '$LABEL' は既に存在します"
          fi
          
          # GitHub API(gh CLI)でラベルを付与
          gh pr edit $PR_NUMBER --repo $REPO --add-label "$LABEL"

# Workflow(Action) 名称
name: Pull Reqeust Automation

# トリガーイベント
on:
  # PR イベント
  pull_request:
    # PR - オープン、再オープン、新しいプッシュコミット時
    types: [opened, synchronize, reopened]


# 同じ Concurrency Group 内で新しいジョブが開始された場合、実行中のジョブをキャンセルする
# 例えばプッシュコミットがトリガーされたジョブがまだ実行されていない状態で再度プッシュされた場合、前のジョブはキャンセルされる
concurrency:
  group: ${{ github.workflow }}-${{ github.ref_name }}
  cancel-in-progress: true

# ジョブ
# ジョブは並行して実行される
jobs:
  # ジョブID
  label-pr-by-file-count:
    # ジョブ名（省略可、ログ表示でわかりやすいように設定）
    name: Label PR by changes file count

    # このジョブが失敗してもワークフロー全体には影響せず、他のジョブは継続する
    continue-on-error: true
    
    # 最大タイムアウト時間を設定し、異常時の無限待機を防止
    timeout-minutes: 10

    # ランナーラベル - GitHub Hosted Runner の ubuntu-latest を使用してジョブを実行
    # プライベートリポジトリの場合は使用量が計算され、超過すると料金が発生する可能性あり
    runs-on: ubuntu-latest

    # ステップ
    # ステップは順番に実行される
    steps:
      # ステップ名
      - name: Get changed file count and apply label
        # ステップID（省略可、後続のステップで出力を参照しない場合は不要）
        id: get-changed-files-count-by-gh
        # 他者が作成したアクションを直接利用
        uses: "pascalgn/[email protected]"
        # 外部環境変数を実行時に注入
        # パラメータ名や利用可能なパラメータは説明を参照：https://github.com/pascalgn/size-label-action/tree/main
        env:
          # secrets.GITHUB_TOKEN は GitHub Actions 実行時に自動生成されるトークン（github-actions の権限）、Secrets に自分で設定不要で、GitHub リポジトリAPIの一部スコープ権限を持つ
          # https://docs.github.com/en/actions/how-tos/security-for-github-actions/security-guides/use-github_token-in-workflows
          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

# Workflow(Action) 名称
name: Pull Reqeust Automation

# Actions ログのタイトル名
run-name: "Pull Reqeust Automation - Daily Checker"

# トリガーイベント
on:
  # PR イベント
  pull_request:
    # PR - オープン、再オープン、新しい Push Commit 時
    types: [opened, synchronize, reopened]


# 同じ Concurrency Group に新しい Job がある場合、実行中のものをキャンセル
# 例えば Push Commit トリガーのジョブがまだ実行されていないのに再度 Push Commit された場合、前のジョブをキャンセル
concurrency:
  group: ${{ github.workflow }}-${{ github.ref_name }}
  cancel-in-progress: true

# Job 作業項目
# Job は並行実行される
jobs:
  # Job ID
  label-pr-by-file-count:
    # 前述参照、省略....
  # ---------
  assign-self-if-no-assignee:
    name: Automatically assign to self if no assignee is specified
    # 共通トリガーイベントのため、Job 内で判定し、Pull Request Opened（初回作成）の場合のみ実行、それ以外はスキップ
    if: github.event_name == 'pull_request' && github.event.action == 'opened'

    # この Job が失敗しても Workflow 全体に影響せず、他の Job を継続
    continue-on-error: true
    
    # 最大タイムアウト時間を設定し、異常時の無限待機を防止
    timeout-minutes: 10
    
    # Runner ラベル - GitHub Hosted Runner ubuntu-latest を使用して作業を実行
    # Private Repo の場合は使用量が計算され、超過すると料金が発生する可能性あり
    runs-on: ubuntu-latest

    steps:
      - name: Assign self if No Assignee
        # GitHub Script (JavaScript) でスクリプトを作成 (Node.js 環境)
        # 上記の Shell Script より便利で見やすい
        # 環境変数や GITHUB_TOKEN を自分で注入する必要なし
        uses: actions/github-script@v7
        with:
          script: \\|
            // github-script では context 変数が自動で注入され、JavaScript から直接参照可能
            // https://docs.github.com/en/actions/learn-github-actions/contexts#github-context

            const issue = context.payload.pull_request; // Issue も対応する場合は context.payload.issue \\|\\| context.payload.pull_request と書ける
            const assignees = issue.assignees \\|\\| [];
            const me = context.actor;

            if (assignees.length === 0) {
              // Assignee を自分に設定
              await github.rest.issues.addAssignees({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: issue.number,
                assignees: [me]
              });

              // コメントで通知
              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: issue.number,
                body: `🔧 No assignee was set, so I have assigned this to myself (@${me}).`
              });
            }

# ワークフロー(Action) 名称
name: Pull Request Automation - Auto Assignee Self

# トリガーイベント
on:
  # PRイベント
  pull_request:
    # PR - オープン時
    types: [opened]

jobs:
  assign-self-if-no-assignee:
    name: 担当者が指定されていない場合に自動で自分を割り当てる
    runs-on: ubuntu-latest
    steps:
      # 前文を参照してください、省略....

# Workflow(Action) 名称
name: Pull Reqeust Automation - Daily Checker

# トリガーイベント
on:
  # スケジュール定期自動実行
  # https://crontab.guru/
  # UTC時間
  schedule:
    # UTCの01:00 = 毎日 UTC+8 の09:00
    - cron: '0 1 * * *'
  # 手動トリガー
  workflow_dispatch:

# Job 作業項目
# Jobは並行実行される
jobs:
  # Job ID
  caculate-pr-status:
    # Job 名称（省略可能、ログ表示が読みやすくなる）
    name: Caculate PR Status
    # Runnerラベル - GitHub Hosted Runner ubuntu-latest を使用して作業を実行
    # Private Repoの場合は使用量が計算され、超過すると費用が発生する可能性あり
    runs-on: ubuntu-latest

    # Job 出力
    outputs:
      pr_list: ${{ steps.pr-info.outputs.pr_list }}

    # 作業ステップ
    # ステップは順番に実行される
    steps:
      # ステップ名
      - name: Fetch open PRs and caculate
        # Step外部でOutputを参照するために設定が必要
        id: pr-info
        uses: actions/github-script@v7
        with:
          script: \\|
            const now = new Date();
            const per_page = 100;
            let page = 1;
            let allPRs = [];
      
            while (true) {
              const { data: prs } = await github.rest.pulls.list({
                owner: context.repo.owner,
                repo: context.repo.repo,
                state: 'open',
                per_page,
                page,
              });
              if (prs.length === 0) break;
              allPRs = allPRs.concat(prs);
              if (prs.length < per_page) break;
              page++;
            }
      
            const result = allPRs.map(pr => {
              const created = new Date(pr.created_at);
              const daysOpen = Math.floor((now - created) / (1000 * 60 * 60 * 24));
              return {
                pr: pr.number.toString(),
                title: pr.title,
                idle: daysOpen
              };
            });

            // Outputに設定、文字列のみ受け付ける
            core.setOutput('pr_list', JSON.stringify(result));
  # ----
  send-pr-summary-message-to-slack:
    name: Send PR Summary Messag to Slack
    # Jobはデフォルトで並行実行、needsを使うと指定Job完了後に実行可能
    needs: [caculate-pr-status]
    runs-on: ubuntu-latest
    
    steps:
      - name: Generate Message
        # Step外部でOutputを参照するために設定が必要
        id: gen-msg
        uses: actions/github-script@v7
        with:
          script: \\|
            const prList = JSON.parse(`${{ needs.caculate-pr-status.outputs.pr_list }}`);
            const blocks = [];
      
            // タイトル
            blocks.push({
              type: "section",
              text: {
                type: "mrkdwn",
                text: `📬 *Open PR Report*\nTotal: *${prList.length}* PR(s)`
              }
            });
      
            // 各PRを1行で表示
            for (const pr of prList) {
              blocks.push({
                type: "section",
                text: {
                  type: "mrkdwn",
                  text: `• <https://github.com/${context.repo.owner}/${context.repo.repo}/pull/${pr.pr}\\|PR #${pr.pr}> *${pr.title}* - 🕒 ${pr.idle} day(s)`
                }
              });
            }

            // Outputに設定、文字列のみ受け付ける
            core.setOutput('blocks', JSON.stringify(blocks));

            
      # Slack公式のSlack API GitHub Actionsを使用
      # https://tools.slack.dev/slack-github-action/sending-techniques/sending-data-slack-api-method/
      # メッセージ送信
      - name: Post text to a Slack channel
        uses: slackapi/[email protected]
        with:
          method: chat.postMessage
          token: ${{ secrets.SLACK_BOT_TOKEN }}
          payload: \\|
            channel: ${{ vars.SLACK_TEAM_CHANNEL_ID }}
            blocks: ${{ steps.gen-msg.outputs.blocks }}
  # ----
  auto-close-old-prs:
    name: Auto Close Old PRs
    needs: [caculate-pr-status]
    runs-on: ubuntu-latest

    steps:
      - name: Auto close PRs opened more than 90 days
        uses: actions/github-script@v7
        with:
          script: \\|
            const prList = JSON.parse(`${{ needs.caculate-pr-status.outputs.pr_list }}`);
            const oldPRs = prList.filter(pr => pr.idle > 90);

            for (const pr of oldPRs) {
              await github.rest.pulls.update({
                owner: context.repo.owner,
                repo: context.repo.repo,
                pull_number: parseInt(pr.pr),
                state: 'closed'
              });

              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: parseInt(pr.pr),
                body: `⚠️ This pull request has been automatically closed because it has been open for more than 90 days. Please reopen if needed.`
              });
            }
            console.log(`Closed ${oldPRs.length} PR(s)`);

name: Automation-label-pr-base-branch
run-name: "[Automation-label-pr-base-branch] ${{ github.event.inputs.PR_NUMBER \\|\\| github.ref }}"

concurrency:
  group: ${{ github.workflow }}-${{ github.event.inputs.PR_NUMBER \\|\\| github.ref }}
  cancel-in-progress: true

# トリガーイベント
on:
  # 他のWorkflowからこのWorkflowを呼び出しトリガー
  workflow_call:
    # 入力データ
    inputs:
      # PR番号
      PR_NUMBER:
        required: true
        type: string
    # シークレット入力
    secrets:
      GH_TOKEN:
        description: "APIアクセス用のGitHubトークン"
        required: true
jobs:
  label-pr-base-branch:
    name: PRのベースブランチにラベル付け
    continue-on-error: true
    timeout-minutes: 10
    runs-on: ubuntu-latest

    steps:
      - name: ベースブランチでPRにラベル付け
        id: label-pr-base-branch
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: \\|
          PR_NUMBER="${{ inputs.PR_NUMBER }}"
          REPO="${{ github.repository }}"

          echo "📦 リポジトリ $REPO のPR #$PR_NUMBER を処理中"

          # PRのベースブランチを取得
          BASE_BRANCH=$(gh pr view "$PR_NUMBER" --repo "$REPO" --json baseRefName --jq '.baseRefName')
          echo "🔖 PRのベースブランチ: $BASE_BRANCH"

          # 許可されたベースブランチのラベル
          BRANCH_LABELS=("develop" "main" "master")

          # ラベルが許可リストにあるか
          if [[ " ${BRANCH_LABELS[@]} " =~ " ${BASE_BRANCH} " ]]; then
            LABEL="$BASE_BRANCH"
          else
            echo "⚠️ ベースブランチ '$BASE_BRANCH' は許可リストにありません。ラベル付けをスキップします。"
            exit 0
          fi

          # 既存のベースブランチラベルを削除
          EXISTING_LABELS=$(gh pr view "$PR_NUMBER" --repo "$REPO" --json labels --jq '.labels[].name')
          for EXISTING in $EXISTING_LABELS; do
            if [[ " ${BRANCH_LABELS[@]} " =~ " ${EXISTING} " ]]; then
              echo "🧹 既存のベースブランチラベルを削除中: $EXISTING"
              gh pr edit "$PR_NUMBER" --repo "$REPO" --remove-label "$EXISTING"
            fi
          done

          # ラベルが存在しなければ作成
          if ! gh label list --repo "$REPO" \\| grep -q "^$LABEL$"; then
            echo "🆕 ラベルを新規作成: $LABEL"
            gh label create "$LABEL" --repo "$REPO" --description "PRが対象とする$LABELブランチ" --color "ededed"
          else
            echo "✅ ラベル '$LABEL' は既に存在します"
          fi

          # ベースブランチラベルを追加
          echo "🏷️ PR #$PR_NUMBER にラベル '$LABEL' を追加"
          gh pr edit "$PR_NUMBER" --repo "$REPO" --add-label "$LABEL"

name: Automation-label-pr-base-branch

on:
  pull_request:
    types: [opened]

jobs:
  call-label-pr-workflow:
    name: Call Base Branch Label Workflow
    # ✅ 呼び出される workflow が同じリポジトリ内の場合：
    #    uses: ./.github/workflows/Automation-label-pr-base-branch.yml
    #    注意：この書き方はブランチを指定できず（呼び出し元 workflow のブランチを固定使用）
    #    参考例：
    #    - CD-Deploy-Form.yml は本リポジトリの workflow を呼び出し
    #    - CD-Deploy.yml は別リポジトリの workflow を呼び出し
    #
    # ✅ 呼び出される workflow が別リポジトリの場合：
    #    uses: {owner}/{repo}/.github/workflows/{file}.yml@{branch_or_tag}
    #    ブランチまたはタグを指定可能
    #    ref: https://github.com/ZhgChgLi/github-actions-ci-cd-demo-share-actions/blob/main/.github/workflows/Automation-label-pr-base-branch.yml
    uses: ZhgChgLi/github-actions-ci-cd-demo-share-actions/.github/workflows/Automation-label-pr-base-branch.yml@main
    with:
      PR_NUMBER: ${{ github.event.number }}
      
    # すべての secrets を呼び出し元 workflow から継承する場合は `inherit` を使う
    # secrets: inherit
    #
    # 特定の secrets のみ渡す場合は個別に指定
    secrets:
      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

name: Demo-Env-Vars

on:
  workflow_dispatch:

jobs:
  print-env-vars:
    runs-on: ubuntu-latest

    steps:
      - name: print-env
        run: env
      - name: context-vars-vs-vars
        env:
          SAY_MY_NAME: "Heisenberg"
          # GitHub Actions Context 式、下記参照
          FROM_REF: "${{ github.ref }}"
        run: \\|
          # Shell スクリプト:
          # カスタム注入された ENV 変数の参照
          # ${SAY_MY_NAME} または $SAY_MY_NAME どちらも可
          # ${XX} は文字列連結に便利:
          echo "HI: ${SAY_MY_NAME}"
          
          # 💡 GitHub Actions Context 式
          # これはシェル変数ではなく、YAML パース時に GitHub Actions が値に置換
          # ⚠ ローカルや GitHub Actions 以外の環境では失敗する
          # 🔗 https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
          BRANCH_NAME_FROM_CONTEXT="${{ github.ref }}"
          
          # 💡 GitHub Actions 実行時の環境変数
          # これらは runner がシェル実行時に自動注入
          # ✅ 他環境では export や ENV で事前定義すれば使用可能
          # 🔗 https://docs.github.com/en/actions/learn-github-actions/environment-variables
          BRANCH_NAME_FROM_ENV_VARS="${GITHUB_REF}"
          
          echo "FROM_REF: ${FROM_REF}"
          echo "BRANCH_NAME_FROM_CONTEXT: ${BRANCH_NAME_FROM_CONTEXT}"
          echo "BRANCH_NAME_FROM_ENV_VARS: ${BRANCH_NAME_FROM_ENV_VARS}"
      - name: print-github-script-env
        uses: actions/github-script@v7
        env:
          SAY_MY_NAME: "Heisenberg"
          # GitHub Actions Context 式、上記参照
          FROM_REF: "${{ github.ref }}"
        with:
          script: \\|
            // GitHub Script: (JavaScript (Node.js)):
            // process.env から ENV 値を取得
            console.log(`HI: ${process.env.SAY_MY_NAME}`);
            console.log(`FROM_REF: ${process.env.FROM_REF}`);
            // github-script では context 変数に自動注入され JS から直接参照可能
            // https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
            const branch_name_from_context_vars = context.ref;
            console.log(`branch_name_from_context_vars: ${branch_name_from_context_vars}`);
            // 同様に GitHub Actions Context 式も使える（あまり意味はないが）:
            const branch_name_from_context = "${{ github.ref }}";
            console.log(`branch_name_from_context: ${branch_name_from_context}`);
            
            for (const [key, value] of Object.entries(process.env)) {
              console.log(`${key}=${value}`);
            }
            // github-script の github オブジェクトは Octokit REST API のインスタンス
            // GitHub API 操作用
            // 例：
            // await github.rest.pulls.list({
            //   owner: context.repo.owner,
            //   repo: context.repo.repo,
            //   state: "open"
            //  });
      # gh CLI はデフォルトで GITHUB_TOKEN を使わず GH_TOKEN が必要
      - name: gh CLI without GH_TOKEN (expected to fail)
        continue-on-error: true
        run: \\|
          PR_COUNT=$(gh pr list --repo $GITHUB_REPOSITORY --json number --jq 'length')
          echo "Found $PR_COUNT open pull requests"
      
      - name: gh CLI with GH_TOKEN (expected to succeed)
        env:
          # GH_TOKEN を設定して gh CLI の認証を可能にする
          # https://docs.github.com/en/actions/how-tos/security-for-github-actions/security-guides/use-github_token-in-workflows
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: \\|
          PR_COUNT=$(gh pr list --repo $GITHUB_REPOSITORY --json number --jq 'length')
          echo "Found $PR_COUNT open pull requests"
      
      - name: github-script auto-authentication (no GH_TOKEN needed)
        uses: actions/github-script@v7
        with:
          script: \\|
            // github = Octokit REST クライアント（GITHUB_TOKEN で自動認証済み）
            const pulls = await github.rest.pulls.list({
              owner: context.repo.owner,
              repo: context.repo.repo,
              state: "open"
            });
            console.log(`Found ${pulls.data.length} open pull requests`);

# 前述を参照してください、省略....
jobs:
  label-pr-by-file-count:
    # 前述を参照してください、省略....
    runs-on: [self-hosted-zhgchgli]
    # 前述を参照してください、省略....
  # ---------
  assign-self-if-no-assignee:
    # 前述を参照してください、省略....
    runs-on: [self-hosted-zhgchgli]

    steps:
      # 前述を参照してください、省略....

jobs:
  test:
    runs-on: ${{ matrix.runner }}
    strategy:
      matrix:
        runner:
          - [self-hosted, linux, high-memory]
          - [self-hosted, macos, xcode-15]

    steps:
      - run: echo "Running on ${{ matrix.runner }}"