GitHub Actions를 활용한 리포지토리 운영 개선: Reusable workflows와 Composite action 도입 사례

name: Deploy

on:
  workflow_call:
    inputs:
      environment:
        description: |
          배포 대상 환경(예: production, staging)
        type: string
        required: true

      node-version:
        description: |
          사용할 Node.js 버전
        type: string
        required: false

      build-command:
        description: |
          프로젝트 빌드에 사용할 스크립트
          `package.json`에 정의된 스크립트에 맞춰 조정

          예: `build`, `generate`
        type: string
        required: false
        default: "generate"

      s3-sync-command:
        description: |
          AWS S3에 배포하기 위한 명령어

          예: `'./dist s3://my-bucket --delete --exclude "logs/*'`
        type: string
        required: true

    secrets:
      aws-role-arn:
        description: |
          AWS 리소스 접근을 허용하기 위한 역할 ARN(GitHub Secrets로 관리)
        required: true

jobs:
  deploy:
    name: Deploy to ${{ inputs.environment }}
    runs-on: ubuntu-22.04
    timeout-minutes: 20
    permissions:
      contents: write
      id-token: write

    steps:
      # Node.js 설정과 의존성 설치
      - name: Setup Node.js and Install dependencies
        uses: my-org/composite-actions/.github/actions/node-setup-and-dependencies@v1
        with:
          node-version: ${{ inputs.node-version }}

      # 프로젝트 빌드
      - name: Build ${{ inputs.environment }}
        run: |
          set -xeu
          npm run ${{ inputs.build-command }}

      # AWS S3로 배포
      - name: Deploy to ${{ inputs.environment }} [${{ inputs.s3-sync-command }}]
        uses: my-org/composite-actions/.github/actions/aws-s3-deploy-conditionally@v1
        with:
          environment: ${{ inputs.environment }}
          aws-role-arn: ${{ secrets.aws-role-arn }}
          s3-sync-command: ${{ inputs.s3-sync-command }}

name: Node.js Setup and Dependency Installation
description: |
  지정된 버전과 옵션에 따라 Node.js와 npm을 설정하고 의존성을 설치합니다.

  주요 기능:
  1. 지정된 Node.js 버전 설치
  2. npm 의존성 설치

inputs:
  skip-checkout:
    description: |
      체크아웃 단계를 건너뛸지 여부
    required: false
    default: "false"

  node-version:
    description: |
      Node.js 버전 지정
    required: false

  npm-install-command:
    description: |
      npm 설치 명령어
    required: false
    default: "ci"

  npm-install-options:
    description: |
      npm 명령어 추가 옵션

      예: `--prefer-offline --no-audit`
    required: false

runs:
  using: composite
  steps:
    - name: Checkout code
      if: ${{ inputs.skip-checkout == 'false' }}
      uses: actions/checkout@v4

    - name: Setup Node.js
      uses: actions/setup-node@v4
      with:
        node-version: ${{ inputs.node-version }}

    - name: Install dependencies
      run: |
        set -xeu

        npm ${{ inputs.npm-install-command}} ${{ inputs.npm-install-options }}
      shell: bash

name: AWS S3 Deploy Conditionally
description: |
  조건에 따라 AWS S3 버킷에 파일을 배포하기 위한 Composite action입니다.

inputs:
  aws-region:
    description: |
      AWS 리전 (예: us-east-1, eu-central-1)
    required: false
    default: "ap-northeast-1"

  aws-role-arn:
    description: |
      AWS 리소스 접근용 역할 ARN (GitHub Secrets 사용)
    required: true

  environment:
    description: |
      배포 대상 환경
    required: true

  s3-sync-command:
    description: |
      실행할 aws s3 sync 명령어

      예: `./dist s3://your-bucket-name/path --delete --exclude "tmp/*"`
    required: true

runs:
  using: composite
  steps:
    - name: Setup AWS Credentials
      uses: aws-actions/configure-aws-credentials@v4
      with:
        role-to-assume: ${{ inputs.aws-role-arn }}
        aws-region: ${{ inputs.aws-region }}

    - name: Deploy to ${{ inputs.environment }} [aws s3 sync ${{ inputs.s3-sync-command }}] and check return code
      run: |
        set -xeu

        # AWS S3 Sync 명령어를 실행하고, 명령어의 표준 출력과 표준 에러 출력을 모두 캡처
        if output=$(aws s3 sync ${{ inputs.s3-sync-command }} 2>&1); then
          {
            echo "## AWS S3 Sync 성공 🚀"
            echo "실행 명령어 \\`aws s3 sync ${{ inputs.s3-sync-command }}\\`"
          } >> "$GITHUB_STEP_SUMMARY"
        else
          ret_code=$?
          error_message=$(echo "$output" | tr '\\n' ' ' | sed 's/"/\\\\"/g')
          echo "::error title=AWS S3 Sync Failure::Failed with return code $ret_code. Error: $error_message"
          {
            echo "## AWS S3 Sync 실패 ❌"
            echo "실행 명령어 \\`aws s3 sync ${{ inputs.s3-sync-command }}\\`"
            echo "에러 출력:"
            echo '```'
            echo "$output"
            echo '```'
          } >> "$GITHUB_STEP_SUMMARY"
          exit $ret_code
        fi
      shell: bash

name: CI/CD
run-name: '${{ github.workflow }} for ${{ github.ref_name }} / ${{ inputs.environment }} [${{ github.event_name }}] [${{ github.sha }}]'

on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Environment to deploy'
        type: environment
        required: true
        default: 'prod'

      s3-dryrun:
        description: 'Dryrun for S3 sync'
        type: boolean
        required: false
        default: false

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}-${{ inputs.environment }}
  cancel-in-progress: true

jobs:
  deploy:
    uses: my-org/github-reusable-workflows/.github/workflows/deploy.yml@v1
    with:
      environment: ${{ inputs.environment }}
      node-version: 20
      build-command: build
      s3-sync-command: >-
        ./dist s3://your-bucket-name/path --delete
        ${{ inputs.s3-dryrun && '--dryrun' || '' }}
    secrets:
      aws-role-arn: ${{ secrets.YOUR_AWS_S3_DEPLOY_ROLE_ARN }}
    permissions:
      contents: write
      id-token: write