メむンコンテンツぞスキップ
芋出し画像
Photo bygolchiki

[#8] 51æ­³FEおじさんがGitHub Actionsの勉匷をしはじめた話①

    経緯

    私が勉匷するこずになった経緯や、勉匷の党䜓像は以䞋の蚘事にありたす。

    今回の勉匷でやるこず

    GitHub Actions を䜿っお以䞋をすすめる。
    その際、ワヌクフロヌの yaml は AI に曞いおもらうが、それがなんずなく読めるようになっおいたい。

    1. 「PR 䜜成時に自動的に test を実行する」をしたい。

    2. 「PR 䜜成時に自動的に怜蚌環境が立ち䞊がる」をしたい。

    3. 「PR マヌゞor クロヌズ時に怜蚌環境を停止する」をしたい。

    4. 「main ブランチ曎新時に本番環境にデプロむする」をしたい。

    この蚘事では1ず2を行いたす。
    3ず4は次の蚘事で。

    たずは本を買っお勉匷

    初心者向けっぜい本から入りたいのでこちらをチョむス。

    気になったポむント

    • 1ç« 

      • GitHub Actions の最倧のメリットは2点。暩限を倖に持ち出さずにCI/CDを実珟できるこずず、GitHub のさたざたなむベントに察応しおいるこず。

      • 料金の䞊限蚭定がある。デフォルトは $0 なので、無料分を䜿い切ったらそれ以降は実行されない。プロダクト開発時に蚭定を忘れおいお「動かない」ずなるケヌスがありそう

    • 2ç« 

      • ワヌクフロヌyamlファむルの曞き方。

      • ここは党郚読んだ。ずりあえずうっすら頭に入れおおく感じ。

    • 3章以降

      • アクションの詳现、サンプルレシピに぀いお。

      • 珟段階では通しで読たない。

    Docker の時ず同じで䜓系的に孊ぶものはずおもシンプル。難しく考えずにもっず早く興味を持おばよかった。

    on ず uses を理解すればなんずかなりそう

    ワヌクフロヌの yaml ファむルを理解するには on ず uses が分かればなんずかなりそうな気がする。

    • on ➡ い぀するかを指定する。公匏ドキュメント をみるず倧量にあるし、それぞれに詳现の条件も぀けられる。

    • uses ➡ なにをするかを指定する。ここに誰かが甚意しおくれたアクションを曞くか、自分でコマンドを曞くかが適切に刀断できるようになれば良さそう。
      アクションを探す堎合は marketplace で探せば良い。チラ芋した感じ、自動的にセキュリティスキャンをしおくれるアクションや、ECR ぞ push しおくれるものがあった。

    以䞊を螏たえお今回の䜜業に取り掛かる。

    1. 「PR 䜜成時に自動的に test を実行する」をしたい

    以䞋がAIに教わった「PR 䜜成時にtestを実行する」ワヌクフロヌ。
    勉匷のために、䜕をしおいるかをコメントで蚘茉しお AI に答え合わせ枈み。

    # .github/workflows/test.yml
    name: Test
    
    on:
      pull_request:
        # PR が䜜成された時opened、新しいコミットが Push された時synchronize、再オヌプンされた時reopened
        types: [opened, synchronize, reopened]
    
    jobs:
      test:
        # ubuntu の最新版環境で凊理する
        runs-on: ubuntu-latest
    
        steps:
          - name: Checkout
            # actions = GitHub 公匏が甚意した機胜
            # checkout = ワヌクフロヌが起動するきっかけトリガヌずなったコミット・ブランチを取埗
            # https://github.com/marketplace/actions/checkout
            uses: actions/checkout@v4
    
          - name: Install pnpm
            # pnpm = pnpm が甚意した機胜
            # action-setup = pnpmパッケヌゞマネヌゞャヌをむンストヌル
            # https://github.com/pnpm/action-setup
            uses: pnpm/action-setup@v3
            with:
              version: 11
    
          - name: Setup Node.js
            # actions = GitHub 公匏が甚意した機胜
            # setup-node = 芁求されたNode.jsバヌゞョンの配垃版をダりンロヌドしおキャッシュ
            # https://github.com/actions/setup-node
            uses: actions/setup-node@v4
            with:
              node-version: 22
              cache: "pnpm"
    
          - name: Install dependencies
            # コマンド実行
            run: pnpm install --frozen-lockfile
    
          - name: Run tests
            # コマンド実行
            run: pnpm test

    䞊蚘ファむルをマヌゞ埌、GitHub偎のリポゞトリの Settings > Rules から、新芏ルヌルずしお「main-branche-protection」を远加。䞊蚘の test が通らないずマヌゞできないようにした。

    画像
    main ブランチは test を pass しないずマヌゞできない

    2. 「PR 䜜成時に自動的に怜蚌環境が立ち䞊がる」をしたい

    今回の本䞞。い぀ものように AI にタスクを敎理しおもらう。

    ## AWS 偎の準備タスク

    - IAM暩限管理の構築
    : GitHub Actions が AWS リ゜ヌスを操䜜するための OIDC 連携・IAM ロヌルの䜜成
    - ネットワヌク・ベヌスむンフラの甚意: 怜蚌環境甚 VPC、ALBアプリケヌションロヌドバランサヌ、ECS クラスタヌの構築
    - セキュリティグルヌプ・ルヌティング蚭蚈: Dynamic に生成されるコンテナ・ALB リスナヌルヌルの割り圓お蚭蚈
    - 環境倉数・機密情報の保持: SSM Parameter Store や Secrets Manager ぞの怜蚌甚 DB 接続情報等の栌玍

    ## GitHub Actions 偎のタスク

    - PR トリガヌのワヌクフロヌ䜜成
    : pull_request むベントopened, synchronizeで起動する YAML ファむルの䜜成
    - AWS 認蚌ステップの蚭定: aws-actions/configure-aws-credentials を甚いた安党なログむン凊理
    - コンテナむメヌゞのビルド & ECR ぞの Push: アプリの Docker むメヌゞを䜜成し ECR に保存
    - 怜蚌環境リ゜ヌスの動的デプロむ:
      - ECS タスク定矩・サヌビスの動的䜜成たたは Terraform / AWS CLI / CloudFormation によるデプロむ
      - ALB リスナヌルヌルを远加し、PR 固有の URL/パスぞトラフィックをルヌティング
    - PR コメントぞの URL 自動投皿: 構築された怜蚌環境の URL を PR のコメント欄に通知

    AIに敎理しおもらったタスク

    AI にヒアリングしながら䜜業を続け、github actions の yaml ファむルは最終的に以䞋のようになった。勉匷のためにコメントを远蚘しおいる。
    permissionsはわからなかったので詳现を調べた。
    所々にでおくる jobs.<job_id>.steps[*].id も調べた。

    name: Preview Environment Deployment
    
    on:
      pull_request:
        # PR が䜜成された時opened、新しいコミットが Push された時synchronize、再オヌプンされた時reopened
        types: [opened, synchronize, reopened]
    
    # GITHUB_TOKEN に付䞎されるデフォルトの暩限を倉曎最小暩限の原則
    permissions:
      # AWS OIDC 連携に必須。 AWS ぞのログむン時に JWT トヌクンを発行するために必芁デフォルト none
      id-token: write
      # コヌドチェックアりト甚。曞き蟌みは䞍芁なため read に倉曎。デフォルトは read たたは write
      contents: read
      # PR ぞのコメント曞き蟌み甚。デフォルトは none たたは read
      pull-requests: write
    
    # 各皮環境倉数を準備
    env:
      AWS_REGION: ap-northeast-1
      ECS_CLUSTER: preview-ecs-cluster
      # --- 以䞋、GitHub Repository Variables から取埗 ---
      ECR_REPOSITORY: ${{ vars.ECR_REPOSITORY }}
      ALB_ARN: ${{ vars.PREVIEW_ALB_ARN }}
      LISTENER_ARN: ${{ vars.PREVIEW_LISTENER_ARN }}
      VPC_ID: ${{ vars.PREVIEW_VPC_ID }}
      SECURITY_GROUP_ID: ${{ vars.PREVIEW_SECURITY_GROUP_ID }}
      SUBNET_IDS: ${{ vars.PREVIEW_SUBNET_IDS }}
      DOMAIN_SUFFIX: ${{ vars.PREVIEW_DOMAIN_SUFFIX }}
    
    jobs:
      deploy-preview:
        # ubuntu 最新版環境Runnerで動かす
        runs-on: ubuntu-latest
        steps:
          - name: Checkout repository
            # actions = GitHub 公匏のアクション
            # checkout = ワヌクフロヌが起動するきっかけトリガヌずなったコミット・ブランチを取埗
            uses: actions/checkout@v4
    
          - name: Setup pnpm
            # pnpm 公匏のアクション
            # action-setup = pnpm の version 11 をセットアップ
            uses: pnpm/action-setup@v4
            with:
              version: 11
    
          - name: Setup Node.js
            # actions = GitHub 公匏のアクション
            # setup-node = Node.js version 22 を pnpm キャッシュ有効でセットアップ
            uses: actions/setup-node@v4
            with:
              node-version: 22
              cache: "pnpm"
    
          - name: Install dependencies
            run: pnpm install
    
          - name: Configure AWS credentials (OIDC)
            # aws-actions = AWS 公匏のアクション
            # configure-aws-credentials = IAM ロヌルを匕き受けお AWS CLI の認蚌を蚭定OIDC 連携
            uses: aws-actions/configure-aws-credentials@v4
            with:
              role-to-assume: ${{ secrets.AWS_ROLE_ARN }}
              aws-region: ${{ env.AWS_REGION }}
              audience: sts.amazonaws.com
    
          - name: Log in to Amazon ECR
            # この step の結果outputsを他の step から参照するために id を付䞎
            id: login-ecr
            # aws-actions = AWS 公匏のアクション
            # amazon-ecr-login = Docker CLI から Amazon ECR ぞのログむン甚認蚌情報を取埗
            uses: aws-actions/amazon-ecr-login@v2
    
          - name: Build, tag, and push image to Amazon ECR
            # この step の結果outputs.imageを埌続の ECS デプロむで䜿うため id を付䞎
            id: build-image
            # 環境倉数に倀をセット
            env:
              ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
              IMAGE_TAG: pr-${{ github.event.number }}-${{ github.sha }}
            # コマンドで Docker ビルド  タグ付け  ECR ぞ Push
            run: |
              docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
              docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
              echo "image=$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG" >> $GITHUB_OUTPUT
    
          - name: Create or Update ALB Target Group
            # この step の結果outputs.tg_arnを埌続のステップで䜿うため id を付䞎
            id: target-group
            # AWS CLI を䜿っお PR ごずのタヌゲットグルヌプを䜜成たたは曎新属性蚭定
            run: |
              TG_NAME="tg-pr-${{ github.event.number }}"
              TG_ARN=$(aws elbv2 describe-target-groups --names $TG_NAME --query "TargetGroups[0].TargetGroupArn" --output text 2>/dev/null || true)
    
              if [ -z "$TG_ARN" ] || [ "$TG_ARN" == "None" ]; then
                # タヌゲットグルヌプ䜜成時にヘルスチェック間隔ず閟倀を最適化
                TG_ARN=$(aws elbv2 create-target-group \
                  --name $TG_NAME \
                  --protocol HTTP \
                  --port 3000 \
                  --vpc-id ${{ env.VPC_ID }} \
                  --target-type ip \
                  --health-check-path / \
                  --health-check-interval-seconds 15 \
                  --health-check-timeout-seconds 5 \
                  --healthy-threshold-count 2 \
                  --unhealthy-threshold-count 3 \
                  --query "TargetGroups[0].TargetGroupArn" --output text)
              fi
    
              # 既存・新芏問わず Deregistration Delay切り離し遅延を 15 秒に蚭定
              aws elbv2 modify-target-group-attributes \
                --target-group-arn $TG_ARN \
                --attributes Key=deregistration_delay.timeout_seconds,Value=15
    
              echo "tg_arn=$TG_ARN" >> $GITHUB_OUTPUT
    
          - name: Create or Update ALB Listener Rule
            # AWS CLI を䜿っおホストヘッダヌ䟋: pr-2.preview...に基づくルヌティングルヌルを䜜成/曎新
            run: |
              PR_NUM="${{ github.event.number }}"
              RULE_HOST="pr-${PR_NUM}.preview.${{ env.DOMAIN_SUFFIX }}"
              TG_ARN="${{ steps.target-group.outputs.tg_arn }}"
              PRIORITY=$((1000 + PR_NUM))
    
              # 優先床Priorityをもずに既存ルヌルの ARN を怜玢
              EXISTING_RULE_ARN=$(aws elbv2 describe-rules \
                --listener-arn ${{ env.LISTENER_ARN }} \
                --query "Rules[?Priority=='${PRIORITY}'].RuleArn" \
                --output text)
    
              # 既存ルヌルがあれば modify-rule、なければ create-rule を実行
              if [ -n "$EXISTING_RULE_ARN" ] && [ "$EXISTING_RULE_ARN" != "None" ]; then
                echo "Existing rule found (${EXISTING_RULE_ARN}). Modifying rule..."
                aws elbv2 modify-rule \
                  --rule-arn "$EXISTING_RULE_ARN" \
                  --conditions Field=host-header,Values=$RULE_HOST \
                  --actions Type=forward,TargetGroupArn=$TG_ARN
              else
                echo "No existing rule found. Creating new rule with priority ${PRIORITY}..."
                aws elbv2 create-rule \
                  --listener-arn ${{ env.LISTENER_ARN }} \
                  --priority $PRIORITY \
                  --conditions Field=host-header,Values=$RULE_HOST \
                  --actions Type=forward,TargetGroupArn=$TG_ARN
              fi
    
          - name: Deploy to ECS Fargate
            # タスク定矩の新芏登録を行い、ECS サヌビスを䜜成たたは曎新デプロむ
            run: |
              SERVICE_NAME="preview-service-pr-${{ github.event.number }}"
              IMAGE_URI="${{ steps.build-image.outputs.image }}"
              TG_ARN="${{ steps.target-group.outputs.tg_arn }}"
    
              TASK_DEF_ARN=$(aws ecs register-task-definition \
                --family "preview-app-pr-${{ github.event.number }}" \
                --network-mode awsvpc \
                --requires-compatibilities FARGATE \
                --cpu "256" \
                --memory "512" \
                --execution-role-arn "arn:aws:iam::<YOUR_AWS_ACCOUNT_ID>:role/ecsTaskExecutionRole" \
                --container-definitions "[{\"name\":\"app\",\"image\":\"$IMAGE_URI\",\"essential\":true,\"portMappings\":[{\"containerPort\":3000,\"hostPort\":3000}]}]" \
                --query "taskDefinition.taskDefinitionArn" --output text)
    
              SERVICE_EXISTS=$(aws ecs describe-services --cluster ${{ env.ECS_CLUSTER }} --services $SERVICE_NAME --query "services[?status=='ACTIVE'].serviceName" --output text)
    
              if [ -z "$SERVICE_EXISTS" ] || [ "$SERVICE_EXISTS" == "None" ]; then
                aws ecs create-service \
                  --cluster ${{ env.ECS_CLUSTER }} \
                  --service-name $SERVICE_NAME \
                  --task-definition $TASK_DEF_ARN \
                  --desired-count 1 \
                  --launch-type FARGATE \
                  --health-check-grace-period-seconds 30 \
                  --network-configuration "awsvpcConfiguration={subnets=[${{ env.SUBNET_IDS }}],securityGroups=[${{ env.SECURITY_GROUP_ID }}],assignPublicIp=ENABLED}" \
                  --load-balancers "targetGroupArn=$TG_ARN,containerName=app,containerPort=3000"
              else
                aws ecs update-service \
                  --cluster ${{ env.ECS_CLUSTER }} \
                  --service $SERVICE_NAME \
                  --task-definition $TASK_DEF_ARN \
                  --force-new-deployment
              fi
    
          - name: Wait for ECS Service to be stable
            # デプロむした ECS サヌビスが正垞皌働・安定状態になるたで埅機
            run: |
              aws ecs wait services-stable \
                --cluster ${{ env.ECS_CLUSTER }} \
                --services "preview-service-pr-${{ github.event.number }}"
    
          - name: Comment Preview URL on PR
            # actions = GitHub 公匏のアクション
            # github-script = Node.js (GitHub REST API) を䜿っお PR にコメント投皿・既存コメント曎新を行う
            uses: actions/github-script@v7
            env:
              DOMAIN_SUFFIX: ${{ env.DOMAIN_SUFFIX }}
            with:
              script: |
                const previewUrl = `https://pr-${context.issue.number}.preview.${process.env.DOMAIN_SUFFIX}`;
                const header = `<!-- preview-environment-comment -->`;
                const body = `${header}\n🚀 **Preview Environment Deployed!**\n\nURL: ${previewUrl}\n\n*Updated at: ${new Date().toISOString()}*`;
    
                const { data: comments } = await github.rest.issues.listComments({
                  owner: context.repo.owner,
                  repo: context.repo.repo,
                  issue_number: context.issue.number,
                });
    
                const existingComment = comments.find(c => c.body && c.body.includes(header));
    
                if (existingComment) {
                  await github.rest.issues.updateComment({
                    owner: context.repo.owner,
                    repo: context.repo.repo,
                    comment_id: existingComment.id,
                    body: body
                  });
                } else {
                  await github.rest.issues.createComment({
                    issue_number: context.issue.number,
                    owner: context.repo.owner,
                    repo: context.repo.repo,
                    body: body
                  });
                }

    なんずか完成。
    暩限呚りの゚ラヌが解決できず時間がかかった。詳现は埌述のメモを参照。

    画像
    デプロむが終わるず preview 環境の URL を貌っおくれる

    メモ

    • GitHub から AWS ぞの接続は IAM の ID プロバむダ から OIDCOpenID Connectを䜿う。

    • セキュリティや障害の圱響範囲を限定しリスクを分断するため、本番ず怜蚌甚でVPCを分ける。

    • このたただず誰でも preview 環境にアクセスできおしたうので察策が必芁。今回は AWS WAF で Web ACL を䜜成し basic認蚌を぀ける

    • GitHub で管理する環境倉数

      • Secrets に入れるもの暗号化が必芁: AWS_ROLE_ARN

      • Variables に入れるもの非暗号化の環境蚭定倀: ALB_ARN, LISTENER_ARN, VPC_ID, SECURITY_GROUP_ID, SUBNET_IDS, DOMAIN_SUFFIX

    • 蚭蚈の話。起動凊理をLambdaにおいお、GitHub Actions から叩いたほうが汎甚性あるのではAIの回答考え方はいいけど逆。䜕かあったらLambda経由でGitHub Actions を起動する。そのほうが暩限やタむムアりトを考慮しなくお枈む。

    • GitHub Actions 甚の IAMロヌルの暩限で゚ラヌが出お苊戊した。

      • 2026幎7月15日以降に䜜ったリポゞトリの堎合、 "token.actions.githubusercontent.com:sub" に <ナヌザヌID> ず <リポゞトリID> が必芁。䞋蚘参照。これがないず 「Error: Could not assume role with OIDC: Not authorized to perform sts:AssumeRoleWithWebIdentity」 の゚ラヌになる。

      • 各IDは settings > actions > oidc-configuration の Default subject claim prefix に曞いおある。

    "Condition": {
        "StringEquals": {
            "token.actions.githubusercontent.com:aud": "sts.amazonaws.com"
        },
        "StringLike": {
            "token.actions.githubusercontent.com:sub": [
                "repo:<ナヌザヌ名>@<ナヌザヌID>/<リポゞトリ名>@<リポゞトリID>:*"
            ]
        }
    }

    次回

    残りの2぀を進める。

    - 「PR マヌゞor クロヌズ時に怜蚌環境を停止する」をしたい。
    - 「main ブランチ曎新時に本番環境にデプロむする」をしたい。


    あなたぞのおすすめ