
[#8] 51æ³FEãããããGitHub Actionsã®å匷ããã¯ããã話â
çµç·¯
ç§ãå匷ããããšã«ãªã£ãçµç·¯ããå匷ã®å šäœåã¯ä»¥äžã®èšäºã«ãããŸãã
ä»åã®å匷ã§ããããš
GitHub Actions ã䜿ã£ãŠä»¥äžãããããã
ãã®éãã¯ãŒã¯ãããŒã® yaml 㯠AI ã«æžããŠãããããããããªããšãªãèªããããã«ãªã£ãŠãããã
ãPR äœææã«èªåçã« test ãå®è¡ãããããããã
ãPR äœææã«èªåçã«æ€èšŒç°å¢ãç«ã¡äžãããããããã
ãPR ããŒãžïŒor ã¯ããŒãºïŒæã«æ€èšŒç°å¢ã忢ãããããããã
ã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 ãéããªããšããŒãžã§ããªãããã«ããã

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 ã«ãã¢ãªã³ã°ããªããäœæ¥ãç¶ãã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
});
}ãªããšã宿ã
æš©éåšãã®ãšã©ãŒã解決ã§ããæéãããã£ãã詳现ã¯åŸè¿°ã®ã¡ã¢ãåç
§ã

ã¡ã¢
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 ãã©ã³ãæŽæ°æã«æ¬çªç°å¢ã«ãããã€ãããããããã