project-auto-wizard 0.14.0 → 0.15.1

package/payload/workflows/next/PROJECT-NEXT-CICD.yaml

@@ -1,330 +0,0 @@
-# project-auto-wizard:managed-workflow
-# Next.js CI/CD deployment
-# Builds a Docker image and deploys it when the {{MAIN_BRANCH}} branch is pushed. Deployed as a Node.js runtime container to support SSR.
-#
-# GitHub Secrets
-#   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)
-#
-# 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-NEXT-CICD
-
-on:
-  push:
-    branches:
-      - "{{MAIN_BRANCH}}"
-    # @wizard paths-anchor (for a monorepo the integrator injects the paths filter here)
-  workflow_dispatch:
-
-env:
-  PROJECT_NAME: "__PROJECT_NAME__"  # @wizard ask:@repo
-  # 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: "nextjs-container"
-  NODE_VERSION: "20.15.0"
-  ENV_FILE_NAME: ".env"
-
-  # 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 command execution timeout
-  SSH_CONNECTION_TIMEOUT: "60s"  # SSH connection timeout
-
-jobs:
-  build:
-    name: Build Next.js application
-    runs-on: ubuntu-latest
-    # In a monorepo (--paths), build inside that subfolder
-    defaults:
-      run:
-        working-directory: ${{ env.PROJECT_PATH }}
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v7
-
-      # 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 }}
-          DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
-          SERVER_HOST: ${{ secrets.SERVER_HOST }}
-          SERVER_USER: ${{ secrets.SERVER_USER }}
-          SERVER_PASSWORD: ${{ secrets.SERVER_PASSWORD }}
-          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 needs SSH_KEY, otherwise SERVER_PASSWORD is required
-          if [ "${SSH_AUTH_METHOD:-password}" = "key" ]; then
-            [ -n "$SSH_KEY" ] || MISSING="$MISSING SSH_KEY"
-          else
-            [ -n "$SERVER_PASSWORD" ] || MISSING="$MISSING SERVER_PASSWORD"
-          fi
-          FAILED=false
-          if [ -n "$MISSING" ]; then
-            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=$(m cicd.precheck_dockerfile_title)::$(m cicd.precheck_dockerfile_body path="${PROJECT_PATH}/${DOCKERFILE#./}")"
-            FAILED=true
-          fi
-          if [ "$FAILED" = "true" ]; then
-            exit 1
-          fi
-          m cicd.precheck_ok
-
-      - 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: 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
-          m cicd.env_file_created file="${{ env.ENV_FILE_NAME }}"
-
-      - name: Cache npm dependencies
-        uses: actions/cache@v6
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-npm-
-
-      - name: Cache node_modules
-        id: node-modules-cache
-        uses: actions/cache@v6
-        with:
-          path: "**/node_modules"
-          key: ${{ runner.os }}-node-modules-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-modules-
-
-      - name: Install dependencies
-        if: steps.node-modules-cache.outputs.cache-hit != 'true'
-        run: npm ci
-
-      - name: Cache Next.js build
-        uses: actions/cache@v6
-        with:
-          path: ${{ env.PROJECT_PATH }}/.next/cache
-          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
-          restore-keys: |
-            ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json') }}-
-            ${{ runner.os }}-nextjs-
-
-      - name: Build with npm
-        run: npm run build
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Log in to DockerHub
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Cache Docker layers
-        uses: actions/cache@v6
-        with:
-          path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ hashFiles('Dockerfile') }}-${{ hashFiles('package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-buildx-
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v5
-        with:
-          context: ${{ env.PROJECT_PATH }}
-          file: ${{ env.PROJECT_PATH }}/Dockerfile
-          push: true
-          tags: ${{ secrets.DOCKERHUB_USERNAME }}/${{ env.PROJECT_NAME }}-${{ env.DOCKER_IMAGE_PREFIX }}:${{ github.ref_name }}
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache-new,mode=max
-
-      - name: Move Docker cache
-        run: |
-          rm -rf /tmp/.buildx-cache
-          mv /tmp/.buildx-cache-new /tmp/.buildx-cache
-
-  deploy:
-    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:
-          SSH_AUTH_METHOD: ${{ env.SSH_AUTH_METHOD }}
-        with:
-          host: ${{ secrets.SERVER_HOST }}
-          username: ${{ secrets.SERVER_USER }}
-          password: ${{ secrets.SERVER_PASSWORD }}
-          key: ${{ secrets.SSH_KEY }}
-          port: ${{ env.SSH_PORT }}
-          command_timeout: ${{ env.SSH_COMMAND_TIMEOUT }}
-          timeout: ${{ env.SSH_CONNECTION_TIMEOUT }}
-          envs: SSH_AUTH_METHOD
-          script: |
-            set -e
-
-            # 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 }}
-
-            # 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
-            m "${{ env.PAW_M_cicd_ssh_auth }}" method="${SSH_AUTH_METHOD}"
-
-            BRANCH=${{ github.ref_name }}
-            PROJECT_NAME="${{ env.PROJECT_NAME }}"
-
-            # Per-branch port and container name
-            PORT=3000
-            CONTAINER_NAME="${PROJECT_NAME}-nextjs"
-
-            if [ "$BRANCH" == "{{MAIN_BRANCH}}" ]; then
-              PORT=${{ secrets.PROJECT_DEPLOY_PORT || '3000' }}
-              CONTAINER_NAME="${PROJECT_NAME}-nextjs-deploy"
-              m "${{ env.PAW_M_cicd_deploy_start }}" branch="$BRANCH"
-            else
-              m "${{ env.PAW_M_cicd_branch_unsupported }}" branch="$BRANCH"
-              exit 1
-            fi
-
-            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}"
-
-            # Pull the Docker image
-            m "${{ env.PAW_M_cicd_pull_image_short }}"
-            SUDO docker pull ${{ secrets.DOCKERHUB_USERNAME }}/${PROJECT_NAME}-${{ env.DOCKER_IMAGE_PREFIX }}:${BRANCH}
-
-            # Clean up the existing container
-            m "${{ env.PAW_M_cicd_container_check }}" container="$CONTAINER_NAME"
-
-            if SUDO docker ps -a --format '{{.Names}}' | grep -Eq "^${CONTAINER_NAME}\$"; then
-              m "${{ env.PAW_M_cicd_container_exists }}" container="$CONTAINER_NAME"
-              SUDO docker rm -f $CONTAINER_NAME
-              m "${{ env.PAW_M_cicd_container_removed }}" container="$CONTAINER_NAME"
-            else
-              m "${{ env.PAW_M_cicd_container_none }}" container="$CONTAINER_NAME"
-            fi
-
-            # Start the new container
-            m "${{ env.PAW_M_cicd_container_run }}" container="$CONTAINER_NAME"
-
-            # Next.js needs a Node.js server for SSR
-            # With standalone mode, run it with node server.js
-            SUDO docker run -d \
-              -p ${PORT}:3000 \
-              --name $CONTAINER_NAME \
-              -e TZ=Asia/Seoul \
-              -e NODE_ENV=production \
-              -v /etc/localtime:/etc/localtime:ro \
-              --restart unless-stopped \
-              ${{ secrets.DOCKERHUB_USERNAME }}/${PROJECT_NAME}-${{ env.DOCKER_IMAGE_PREFIX }}:${BRANCH}
-
-            # Confirm the deployment
-            m "${{ env.PAW_M_cicd_deploy_done }}"
-            echo ""
-            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 ""
-            m "${{ env.PAW_M_cicd_summary_url }}" url="http://${{ secrets.SERVER_HOST }}:${PORT}"
-
-# Next.js Dockerfile example (standalone mode)
-#
-# # Stage 1: Dependencies
-# FROM node:20-alpine AS deps
-# WORKDIR /app
-# COPY package*.json ./
-# RUN npm ci --only=production
-#
-# # Stage 2: Builder
-# FROM node:20-alpine AS builder
-# WORKDIR /app
-# COPY --from=deps /app/node_modules ./node_modules
-# COPY . .
-# RUN npm run build
-#
-# # Stage 3: Runner
-# FROM node:20-alpine AS runner
-# WORKDIR /app
-# ENV NODE_ENV production
-#
-# RUN addgroup --system --gid 1001 nodejs
-# RUN adduser --system --uid 1001 nextjs
-#
-# COPY --from=builder /app/public ./public
-# COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./
-# COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static
-#
-# USER nextjs
-# EXPOSE 3000
-# ENV PORT 3000
-# CMD ["node", "server.js"]
-#
-# Add the standalone setting to next.config.js:
-# module.exports = {
-#   output: 'standalone',
-# }