project-auto-wizard 0.13.3 → 0.14.0

package/payload/workflows/react/PROJECT-REACT-CICD.yaml

@@ -1,20 +1,20 @@
 # project-auto-wizard:managed-workflow
-# React CI/CD 배포
-# {{MAIN_BRANCH}} 브랜치 푸시 시 Docker 이미지를 빌드하고 배포합니다.
+# React CI/CD deployment
+# Builds a Docker image and deploys it when the {{MAIN_BRANCH}} branch is pushed.
 #
 # GitHub Secrets
-#   ENV_FILE: .env 파일 내용
-#   DOCKERHUB_USERNAME: DockerHub 사용자명
-#   DOCKERHUB_TOKEN: DockerHub 액세스 토큰
-#   SERVER_HOST: 배포 서버 주소
-#   SERVER_USER: SSH 사용자명
-#   SERVER_PASSWORD: SSH 비밀번호 (SSH_AUTH_METHOD=password일 때)
-#   SSH_KEY: SSH 개인키 .pem 내용 (SSH_AUTH_METHOD=key일 때, AWS EC2 등)
-#   PROJECT_DEPLOY_PORT (선택): 배포 포트 (기본: 3000)
+#   ENV_FILE: contents of the .env file
+#   DOCKERHUB_USERNAME: DockerHub username
+#   DOCKERHUB_TOKEN: DockerHub access token
+#   SERVER_HOST: deploy server address
+#   SERVER_USER: SSH username
+#   SERVER_PASSWORD: SSH password (when SSH_AUTH_METHOD=password)
+#   SSH_KEY: contents of the SSH private key .pem (when SSH_AUTH_METHOD=key, e.g. AWS EC2)
+#   PROJECT_DEPLOY_PORT (optional): deploy port (default: 3000)
 #
-# 환경변수 (env 섹션에서 설정)
-#   SSH_AUTH_METHOD: SSH 인증 방식 password | key (기본: password)
-#   SSH_PORT (기본: 2022), SSH_COMMAND_TIMEOUT (기본: 600s), SSH_CONNECTION_TIMEOUT (기본: 60s)
+# Environment variables (set in the env section)
+#   SSH_AUTH_METHOD: SSH auth method password | key (default: password)
+#   SSH_PORT (default: 2022), SSH_COMMAND_TIMEOUT (default: 600s), SSH_CONNECTION_TIMEOUT (default: 60s)
 
 name: PROJECT-REACT-CICD
 
@@ -22,41 +22,42 @@ on:
   push:
     branches:
       - "{{MAIN_BRANCH}}"
-    # @wizard paths-anchor (모노레포일 때 integrator가 paths 필터를 여기 주입)
+    # @wizard paths-anchor (for a monorepo the integrator injects the paths filter here)
   workflow_dispatch:
 
 env:
   PROJECT_NAME: "__PROJECT_NAME__"  # @wizard ask:@repo
-  # 모노레포(--paths)에서 이 프로젝트가 있는 하위 경로. 빌드·Docker context의 기준 ('.'이면 레포 루트)
+  # Subdirectory of this project in a monorepo (--paths). Base for the build and Docker context ('.' means the repo root)
   PROJECT_PATH: "."  # @wizard auto:project-path
   DOCKER_IMAGE_PREFIX: "front-container"
   NODE_VERSION: "20.15.0"
   ENV_FILE_NAME: ".env"
 
-  # SSH 인증 방식: "password"(Synology·일반 서버) | "key"(AWS EC2·.pem)
-  #   password → SERVER_PASSWORD secret 사용
-  #   key      → SSH_KEY secret 사용 (.pem 파일 전체 내용을 secret 값으로)
+  # SSH auth method: "password" (Synology, generic servers) | "key" (AWS EC2, .pem)
+  #   password -> uses the SERVER_PASSWORD secret
+  #   key      -> uses the SSH_KEY secret (the whole .pem file content as the secret value)
   SSH_AUTH_METHOD: "password"  # @wizard ask:password
 
   SSH_PORT: "__SSH_PORT__"  # @wizard ask:2022
-  SSH_COMMAND_TIMEOUT: "600s"  # SSH 명령 실행 타임아웃
-  SSH_CONNECTION_TIMEOUT: "60s"  # SSH 연결 타임아웃
+  SSH_COMMAND_TIMEOUT: "600s"  # SSH command execution timeout
+  SSH_CONNECTION_TIMEOUT: "60s"  # SSH connection timeout
 
 jobs:
   build:
-    name: React/Next.js 애플리케이션 빌드
+    name: Build React/Next.js application
     runs-on: ubuntu-latest
-    # 모노레포(--paths)면 그 하위 폴더에서 빌드한다
+    # In a monorepo (--paths), build inside that subfolder
     defaults:
       run:
         working-directory: ${{ env.PROJECT_PATH }}
 
     steps:
-      - name: 코드 체크아웃
+      - name: Checkout repository
         uses: actions/checkout@v7
 
-      # 필수 Secret·Dockerfile이 없으면 docker 로그인 같은 서드파티 오류 대신 빠진 항목을 알려 주고 멈춘다
-      - name: 배포 사전 점검 (Secret·Dockerfile)
+      # If a required Secret or the Dockerfile is missing, report the missing item and stop
+      # instead of failing later with a third-party error such as docker login
+      - name: Deploy pre-check (Secrets and Dockerfile)
         working-directory: ${{ env.PROJECT_PATH }}
         env:
           DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
@@ -67,11 +68,12 @@ jobs:
           SSH_KEY: ${{ secrets.SSH_KEY }}
           DOCKERFILE: Dockerfile
         run: |
+          m() { (cd "$GITHUB_WORKSPACE" && python3 .github/scripts/messages.py get "$@"); }
           MISSING=""
           for NAME in DOCKERHUB_USERNAME DOCKERHUB_TOKEN SERVER_HOST SERVER_USER; do
             [ -n "${!NAME}" ] || MISSING="$MISSING $NAME"
           done
-          # SSH_AUTH_METHOD=key면 SSH_KEY, 아니면 SERVER_PASSWORD가 필요하다
+          # SSH_AUTH_METHOD=key needs SSH_KEY, otherwise SERVER_PASSWORD is required
           if [ "${SSH_AUTH_METHOD:-password}" = "key" ]; then
             [ -n "$SSH_KEY" ] || MISSING="$MISSING SSH_KEY"
           else
@@ -79,33 +81,34 @@ jobs:
           fi
           FAILED=false
           if [ -n "$MISSING" ]; then
-            echo "::error title=필수 Secret 누락::등록되지 않은 GitHub Secret:$MISSING — Settings → Secrets and variables → Actions에서 등록하세요"
+            echo "::error title=$(m cicd.precheck_secret_title)::$(m cicd.precheck_secret_body missing="$MISSING")"
             FAILED=true
           fi
           if [ ! -f "$DOCKERFILE" ]; then
-            echo "::error title=Dockerfile 없음::${PROJECT_PATH}/${DOCKERFILE#./} 파일이 없습니다. 이 워크플로우는 Docker 이미지로 배포하므로 Dockerfile이 필요합니다 (서버 배포를 하지 않는다면 이 워크플로우 파일을 삭제하세요)"
+            echo "::error title=$(m cicd.precheck_dockerfile_title)::$(m cicd.precheck_dockerfile_body path="${PROJECT_PATH}/${DOCKERFILE#./}")"
             FAILED=true
           fi
           if [ "$FAILED" = "true" ]; then
             exit 1
           fi
-          echo "✅ 사전 점검 통과: 필수 Secret과 Dockerfile이 모두 있습니다"
+          m cicd.precheck_ok
 
-      - name: Node.js 설정
+      - name: Set up Node.js
         uses: actions/setup-node@v7
         with:
           node-version: ${{ env.NODE_VERSION }}
           cache: 'npm'
           cache-dependency-path: ${{ env.PROJECT_PATH }}/package-lock.json
 
-      - name: 환경변수 파일 생성 (${{ env.ENV_FILE_NAME }})
+      - name: Create environment file (${{ env.ENV_FILE_NAME }})
         run: |
+          m() { (cd "$GITHUB_WORKSPACE" && python3 .github/scripts/messages.py get "$@"); }
           cat << 'EOF' > ./${{ env.ENV_FILE_NAME }}
           ${{ secrets.ENV_FILE || secrets.ENV }}
           EOF
-          echo "✅ ${{ env.ENV_FILE_NAME }} 파일 생성 완료"
+          m cicd.env_file_created file="${{ env.ENV_FILE_NAME }}"
 
-      - name: npm 의존성 캐싱
+      - name: Cache npm dependencies
         uses: actions/cache@v6
         with:
           path: ~/.npm
@@ -113,7 +116,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-npm-
 
-      - name: node_modules 캐싱
+      - name: Cache node_modules
         id: node-modules-cache
         uses: actions/cache@v6
         with:
@@ -122,11 +125,11 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-modules-
 
-      - name: 의존성 설치
+      - name: Install dependencies
         if: steps.node-modules-cache.outputs.cache-hit != 'true'
         run: npm ci
 
-      - name: Next.js 빌드 캐싱
+      - name: Cache Next.js build
         uses: actions/cache@v6
         with:
           path: ${{ env.PROJECT_PATH }}/.next/cache
@@ -138,10 +141,10 @@ jobs:
       - name: Build with npm
         run: npm run build
 
-      - name: Docker 빌드환경 설정
+      - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      - name: DockerHub 로그인
+      - name: Log in to DockerHub
         uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
@@ -155,7 +158,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-buildx-
 
-      - name: Docker 이미지 빌드 및 푸시
+      - name: Build and push Docker image
         uses: docker/build-push-action@v5
         with:
           context: ${{ env.PROJECT_PATH }}
@@ -171,11 +174,25 @@ jobs:
           mv /tmp/.buildx-cache-new /tmp/.buildx-cache
 
   deploy:
-    name: 원격 서버 배포
+    name: Deploy to remote server
     needs: build
     runs-on: ubuntu-latest
 
     steps:
+      # The deploy script runs on the remote server, so the messages are resolved here
+      # and handed to it through env vars (PAW_M_*)
+      - name: Checkout message catalog
+        uses: actions/checkout@v7
+        with:
+          sparse-checkout: |
+            .github/scripts/messages.py
+            version.yml
+          sparse-checkout-cone-mode: false
+
+      - name: Load messages
+        run: |
+          python3 .github/scripts/messages.py dump cicd. | PYTHONIOENCODING=utf-8 python3 -c 'import json,sys; [print("PAW_M_" + k.replace(".", "_") + "=" + v) for k, v in json.load(sys.stdin).items()]' >> "$GITHUB_ENV"
+
       - name: Deploy
         uses: appleboy/ssh-action@v1.0.3
         env:
@@ -192,76 +209,79 @@ jobs:
           script: |
             set -e
 
-            # 배포 환경 변수 설정
-            echo "🔧 환경변수 설정.."
+            # Fill the {name} placeholders of a message template (usage: m "template" name=value ...)
+            m() { local s="$1" kv; shift; for kv in "$@"; do s="${s//\{${kv%%=*}\}/${kv#*=}}"; done; printf '%s\n' "$s"; }
+
+            # Set deploy environment variables
+            m "${{ env.PAW_M_cicd_setup_env }}"
             export PATH=$PATH:/usr/local/bin
             export PW=${{ secrets.SERVER_PASSWORD }}
 
-            # SSH 인증 방식에 따른 sudo 추상화
-            #   password 모드: echo $PW | sudo -S  (Synology 등 sudo 비밀번호 필요 서버)
-            #   key 모드: sudo 직접  (AWS EC2 등 passwordless sudo 서버)
+            # sudo abstraction per SSH auth method
+            #   password mode: echo $PW | sudo -S  (servers that need a sudo password, e.g. Synology)
+            #   key mode: plain sudo  (passwordless-sudo servers, e.g. AWS EC2)
             SSH_AUTH_METHOD="${SSH_AUTH_METHOD:-password}"
             if [ "${SSH_AUTH_METHOD}" = "key" ]; then
               SUDO() { sudo "$@"; }
             else
               SUDO() { echo "$PW" | sudo -S "$@"; }
             fi
-            echo "🔐 SSH 인증 방식: ${SSH_AUTH_METHOD}"
+            m "${{ env.PAW_M_cicd_ssh_auth }}" method="${SSH_AUTH_METHOD}"
 
-            # GitHub에서 전달받은 브랜치명
+            # Branch name passed from GitHub
             BRANCH=${{ github.ref_name }}
 
-            # 프로젝트 설정
+            # Project settings
             PROJECT_NAME="${{ env.PROJECT_NAME }}"
 
-            # 브랜치별 포트 및 컨테이너명 설정
-            # 기본값 설정
+            # Per-branch port and container name
+            # Defaults
             PORT=3000
             CONTAINER_NAME="${PROJECT_NAME}-front"
 
-            # 브랜치에 따른 환경별 설정
+            # Per-branch environment settings
             if [ "$BRANCH" == "{{MAIN_BRANCH}}" ]; then
-              # 🚀 배포 환경 ({{MAIN_BRANCH}} 브랜치)
-              # GitHub Secrets의 PROJECT_DEPLOY_PORT 환경변수 사용
-              # 설정되어 있지 않으면 기본값 3000 사용
+              # 🚀 Deploy environment ({{MAIN_BRANCH}} branch)
+              # Uses the PROJECT_DEPLOY_PORT value from GitHub Secrets
+              # Falls back to 3000 when it is not set
               PORT=${{ secrets.PROJECT_DEPLOY_PORT || '3000' }}
               CONTAINER_NAME="${PROJECT_NAME}-front-deploy"
-              echo "🚀 배포 환경으로 배포합니다 (브랜치: $BRANCH)"
+              m "${{ env.PAW_M_cicd_deploy_start }}" branch="$BRANCH"
 
             else
-              # 기타 브랜치 (예상치 못한 브랜치)
-              echo "⚠️ 지원하지 않는 브랜치입니다: $BRANCH"
-              echo "이 워크플로우는 {{MAIN_BRANCH}} 브랜치만 지원합니다."
-              echo "on.push.branches에서 지원할 브랜치를 설정하세요."
+              # Any other branch (unexpected)
+              m "${{ env.PAW_M_cicd_branch_unsupported }}" branch="$BRANCH"
+              m "${{ env.PAW_M_cicd_branch_only }}" branch="{{MAIN_BRANCH}}"
+              m "${{ env.PAW_M_cicd_branch_hint }}"
               exit 1
             fi
 
-            # 설정 정보 출력
-            echo "📋 배포 설정 정보:"
-            echo "  - 브랜치: $BRANCH"
-            echo "  - 프로젝트: $PROJECT_NAME"
-            echo "  - 컨테이너 이름: $CONTAINER_NAME"
-            echo "  - 포트: $PORT"
-            echo "  - Docker 이미지: ${{ secrets.DOCKERHUB_USERNAME }}/${PROJECT_NAME}-${{ env.DOCKER_IMAGE_PREFIX }}:${BRANCH}"
+            # Print the settings
+            m "${{ env.PAW_M_cicd_config_title }}"
+            m "${{ env.PAW_M_cicd_config_branch }}" branch="$BRANCH"
+            m "${{ env.PAW_M_cicd_config_project }}" project="$PROJECT_NAME"
+            m "${{ env.PAW_M_cicd_config_container }}" container="$CONTAINER_NAME"
+            m "${{ env.PAW_M_cicd_config_port }}" port="$PORT"
+            m "${{ env.PAW_M_cicd_config_image }}" image="${{ secrets.DOCKERHUB_USERNAME }}/${PROJECT_NAME}-${{ env.DOCKER_IMAGE_PREFIX }}:${BRANCH}"
 
-            # Docker 이미지 풀 (Pull)
-            echo "⬇️ Docker 이미지 풀: ${{ secrets.DOCKERHUB_USERNAME }}/${PROJECT_NAME}-${{ env.DOCKER_IMAGE_PREFIX }}:${BRANCH}"
+            # Pull the Docker image
+            m "${{ env.PAW_M_cicd_pull_image }}" image="${{ secrets.DOCKERHUB_USERNAME }}/${PROJECT_NAME}-${{ env.DOCKER_IMAGE_PREFIX }}:${BRANCH}"
             SUDO docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${PROJECT_NAME}-${{ env.DOCKER_IMAGE_PREFIX }}:${BRANCH}
 
-            # 기존 컨테이너 정리
-            echo "🧹 컨테이너 $CONTAINER_NAME 존재 여부 확인 중..."
+            # Clean up the existing container
+            m "${{ env.PAW_M_cicd_container_check }}" container="$CONTAINER_NAME"
 
-            # 동일한 이름의 컨테이너가 존재하는지 확인
+            # Check whether a container with the same name exists
             if SUDO docker ps -a --format '{{.Names}}' | grep -Eq "^${CONTAINER_NAME}\$"; then
-              echo "⚠️ 컨테이너 $CONTAINER_NAME 이(가) 존재합니다. 중지 및 삭제 중..."
+              m "${{ env.PAW_M_cicd_container_exists }}" container="$CONTAINER_NAME"
               SUDO docker rm -f $CONTAINER_NAME
-              echo "✅ 컨테이너 $CONTAINER_NAME 이(가) 삭제되었습니다."
+              m "${{ env.PAW_M_cicd_container_removed }}" container="$CONTAINER_NAME"
             else
-              echo "ℹ️ 존재하는 컨테이너 $CONTAINER_NAME 이(가) 없습니다."
+              m "${{ env.PAW_M_cicd_container_none }}" container="$CONTAINER_NAME"
             fi
 
-            # 새 컨테이너 실행
-            echo "🚀 새로운 컨테이너 $CONTAINER_NAME 실행 중..."
+            # Start the new container
+            m "${{ env.PAW_M_cicd_container_run }}" container="$CONTAINER_NAME"
 
             SUDO docker run -d \
               -p ${PORT}:3000 \
@@ -270,27 +290,27 @@ jobs:
               -v /etc/localtime:/etc/localtime:ro \
               ${{ secrets.DOCKERHUB_USERNAME }}/${PROJECT_NAME}-${{ env.DOCKER_IMAGE_PREFIX }}:${BRANCH}
 
-            # 배포 완료 확인
-            echo "✅ 배포가 성공적으로 완료되었습니다!"
+            # Confirm the deployment
+            m "${{ env.PAW_M_cicd_deploy_done }}"
             echo ""
-            echo "📋 배포 결과 요약:"
-            echo "  🎯 프로젝트: $PROJECT_NAME"
-            echo "  🌿 브랜치: $BRANCH"
-            echo "  🐳 컨테이너: $CONTAINER_NAME"
-            echo "  🌐 포트: $PORT"
-            echo "  ⏰ 배포 시간: $(date '+%Y-%m-%d %H:%M:%S')"
+            m "${{ env.PAW_M_cicd_summary_title }}"
+            m "${{ env.PAW_M_cicd_summary_project }}" project="$PROJECT_NAME"
+            m "${{ env.PAW_M_cicd_summary_branch }}" branch="$BRANCH"
+            m "${{ env.PAW_M_cicd_summary_container }}" container="$CONTAINER_NAME"
+            m "${{ env.PAW_M_cicd_summary_port }}" port="$PORT"
+            m "${{ env.PAW_M_cicd_summary_time }}" time="$(date '+%Y-%m-%d %H:%M:%S')"
             echo ""
-            echo "🔗 접속 URL: http://${{ secrets.SERVER_HOST }}:${PORT}"
+            m "${{ env.PAW_M_cicd_summary_url }}" url="http://${{ secrets.SERVER_HOST }}:${PORT}"
 
-# 사용 예시 - {{MAIN_BRANCH}} 브랜치 사용
+# Usage example - using the {{MAIN_BRANCH}} branch
 #
-# 현재 설정: {{MAIN_BRANCH}} 브랜치에 push할 때 자동 배포
+# Current setup: deploys automatically on push to the {{MAIN_BRANCH}} branch
 #
-# 브랜치별 포트:
-# - {{MAIN_BRANCH}}: 3000 (PROJECT_DEPLOY_PORT secret으로 변경 가능)
+# Port per branch:
+# - {{MAIN_BRANCH}}: 3000 (can be changed with the PROJECT_DEPLOY_PORT secret)
 #
-# 필요한 Secrets:
-# - REACT_ENV_FILE, DOCKERHUB_*, SERVER_* (필수)
-# - PROJECT_DEPLOY_PORT (선택, 기본값: 3000)
+# Required Secrets:
+# - REACT_ENV_FILE, DOCKERHUB_*, SERVER_* (required)
+# - PROJECT_DEPLOY_PORT (optional, default: 3000)
 #