@daawoonkim/create-arch-app 0.1.0 → 0.2.0

package/.github/WORKFLOWS.md

@@ -0,0 +1,255 @@
+# CI/CD 워크플로우 가이드
+
+이 프로젝트는 GitHub Actions를 사용하여 자동화된 테스트와 배포를 수행합니다.
+
+## 📋 워크플로우 목록
+
+### 1. **PR Tests** (`test.yml`)
+Pull Request 생성 시 자동 실행
+
+**실행 조건:**
+- Pull Request가 main 브랜치를 대상으로 생성될 때
+
+**수행 작업:**
+- Node.js 18.x, 20.x, 22.x에서 테스트
+- 의존성 설치 및 빌드
+- TypeScript 타입 체크
+- CLI 설치 및 프로젝트 생성 테스트
+
+### 2. **Lint** (`lint.yml`)
+코드 품질 체크
+
+**실행 조건:**
+- main 브랜치 push
+- Pull Request 생성
+
+**수행 작업:**
+- TypeScript 타입 체크
+- console.log 검사 (경고)
+
+### 3. **Auto Deploy on Main** (`deploy-main.yml`) ⭐
+main 브랜치 merge 시 자동 배포
+
+**실행 조건:**
+- main 브랜치에 push (merge 포함)
+- 문서 파일 변경은 제외
+
+**수행 작업:**
+1. package.json 버전 확인
+2. 해당 버전의 태그가 없으면 배포 진행
+3. npm에 자동 배포
+4. Git 태그 자동 생성
+5. GitHub Release 자동 생성
+
+**중요:** 배포 전에 package.json 버전을 미리 업데이트해야 합니다!
+
+### 4. **Publish to npm** (`publish.yml`)
+태그 기반 수동 배포 (백업용)
+
+**실행 조건:**
+- `v*.*.*` 형식의 태그 push
+
+**수행 작업:**
+- 빌드 및 검증
+- npm 배포
+- GitHub Release 생성
+
+---
+
+## 🚀 배포 워크플로우
+
+### 자동 배포 (추천)
+
+```bash
+# 1. 기능 개발
+git checkout -b feature/my-feature
+# ... 코드 작성 ...
+
+# 2. package.json 버전 업데이트
+npm version patch  # 0.1.0 → 0.1.1
+# 또는
+npm version minor  # 0.1.0 → 0.2.0
+
+# 3. 커밋 및 푸시
+git push origin feature/my-feature
+
+# 4. PR 생성 및 merge
+# GitHub에서 PR 생성 → 리뷰 → Merge
+
+# 5. 자동 배포!
+# main에 merge되면:
+# ✅ 자동으로 npm 배포
+# ✅ Git 태그 생성 (v0.1.1)
+# ✅ GitHub Release 생성
+```
+
+### 수동 배포 (백업)
+
+```bash
+# main 브랜치에서
+git checkout main
+git pull origin main
+
+# 버전 업데이트 (자동으로 커밋 & 태그 생성)
+npm version patch
+
+# 태그 푸시
+git push --follow-tags
+
+# 자동으로 배포됨
+```
+
+---
+
+## ⚠️ 주의사항
+
+### package.json 버전 관리
+
+**중요:** PR에서 package.json 버전을 미리 업데이트해야 합니다!
+
+```bash
+# ❌ 잘못된 방법
+git checkout -b feature/my-feature
+# ... 코드 작성 ...
+git commit -m "feat: add feature"
+# merge → 배포 안됨 (버전이 이미 존재)
+
+# ✅ 올바른 방법
+git checkout -b feature/my-feature
+# ... 코드 작성 ...
+npm version patch  # 버전 업데이트!
+git push
+# merge → 자동 배포!
+```
+
+### 배포 스킵
+
+다음과 같은 경우 배포가 자동으로 스킵됩니다:
+
+- 문서 파일만 변경 (*.md)
+- GitHub Actions 파일만 변경
+- LICENSE 파일만 변경
+- package.json 버전이 이미 태그로 존재
+
+### 배포 실패 시
+
+1. **npm 토큰 확인**
+   - GitHub Settings → Secrets → `NPM_TOKEN` 확인
+
+2. **버전 중복**
+   - 이미 같은 버전이 npm에 있는지 확인
+   - package.json 버전 증가 필요
+
+3. **빌드 실패**
+   - 로컬에서 `npm run build` 테스트
+   - TypeScript 에러 확인
+
+---
+
+## 🔧 설정
+
+### 필수 Secrets
+
+GitHub Repository Settings → Secrets and variables → Actions에서 설정:
+
+1. **NPM_TOKEN** (필수)
+   - npm 웹사이트에서 Automation Token 생성
+   - https://www.npmjs.com/settings/[username]/tokens
+   - Type: "Automation" 선택
+   
+2. **GITHUB_TOKEN** (자동)
+   - GitHub이 자동으로 제공
+
+---
+
+## 📊 배포 히스토리 확인
+
+### GitHub Actions
+https://github.com/hec8897/create-arch-app/actions
+
+### npm 버전
+https://www.npmjs.com/package/@daawoonkim/create-arch-app
+
+### GitHub Releases
+https://github.com/hec8897/create-arch-app/releases
+
+---
+
+## 🐛 트러블슈팅
+
+### "Tag already exists" 에러
+```bash
+# 해결: package.json 버전 증가
+npm version patch
+git push origin feature-branch
+```
+
+### "NPM_TOKEN not found" 에러
+```bash
+# 해결: GitHub Secrets에 NPM_TOKEN 추가
+# Settings → Secrets → New repository secret
+```
+
+### 배포가 안됨
+```bash
+# 1. 버전 확인
+cat package.json | grep version
+
+# 2. 태그 확인
+git tag -l
+
+# 3. 버전이 다르면 자동 배포됨
+# 버전이 같으면 스킵됨
+```
+
+---
+
+## 📝 CHANGELOG 업데이트
+
+배포 전에 CHANGELOG.md를 수동으로 업데이트하는 것을 권장합니다:
+
+```markdown
+## [0.1.1] - 2024-01-25
+
+### Added
+- 새로운 기능 추가
+
+### Fixed
+- 버그 수정
+
+### Changed
+- 기능 개선
+```
+
+---
+
+## 🎯 베스트 프랙티스
+
+1. **버전 관리**
+   - Semantic Versioning 준수 (major.minor.patch)
+   - 의미 있는 버전 증가
+
+2. **커밋 메시지**
+   - feat: 새 기능
+   - fix: 버그 수정
+   - docs: 문서 변경
+   - chore: 빌드/설정 변경
+
+3. **배포 전 체크리스트**
+   - [ ] 로컬 빌드 성공
+   - [ ] TypeScript 에러 없음
+   - [ ] CHANGELOG 업데이트
+   - [ ] package.json 버전 증가
+   - [ ] PR 리뷰 완료
+
+4. **긴급 배포**
+   - hotfix 브랜치 사용
+   - 버전 패치 증가
+   - 빠른 merge
+
+---
+
+## 📞 문의
+
+워크플로우 관련 문제가 있으면 Issue를 생성해주세요:
+https://github.com/hec8897/create-arch-app/issues

package/.github/workflows/deploy-main.yml

@@ -0,0 +1,101 @@
+name: Auto Deploy on Main
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+      - '.github/**'
+      - 'LICENSE'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    
+    permissions:
+      contents: write
+      id-token: write
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+      
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Build
+        run: npm run build
+      
+      - name: Check if version changed
+        id: version_check
+        run: |
+          CURRENT_VERSION=$(node -p "require('./package.json').version")
+          echo "current_version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
+          
+          # Check if tag already exists
+          if git rev-parse "v$CURRENT_VERSION" >/dev/null 2>&1; then
+            echo "should_deploy=false" >> $GITHUB_OUTPUT
+            echo "Tag v$CURRENT_VERSION already exists. Skipping deployment."
+          else
+            echo "should_deploy=true" >> $GITHUB_OUTPUT
+            echo "New version detected: $CURRENT_VERSION"
+          fi
+      
+      - name: Publish to npm
+        if: steps.version_check.outputs.should_deploy == 'true'
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      
+      - name: Create and push tag
+        if: steps.version_check.outputs.should_deploy == 'true'
+        run: |
+          VERSION="${{ steps.version_check.outputs.current_version }}"
+          git tag "v$VERSION"
+          git push origin "v$VERSION"
+      
+      - name: Create GitHub Release
+        if: steps.version_check.outputs.should_deploy == 'true'
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v${{ steps.version_check.outputs.current_version }}
+          release_name: Release ${{ steps.version_check.outputs.current_version }}
+          body: |
+            ## 🚀 Release ${{ steps.version_check.outputs.current_version }}
+            
+            Automatically deployed from main branch.
+            
+            ### 📦 Installation
+            
+            \`\`\`bash
+            npx @daawoonkim/create-arch-app my-app
+            \`\`\`
+            
+            ### 📝 Changes
+            
+            See [CHANGELOG.md](https://github.com/${{ github.repository }}/blob/main/CHANGELOG.md) for details.
+            
+            ### 🔗 Links
+            
+            - [npm Package](https://www.npmjs.com/package/@daawoonkim/create-arch-app/v/${{ steps.version_check.outputs.current_version }})
+            - [Documentation](https://github.com/${{ github.repository }})
+          draft: false
+          prerelease: false

package/.github/workflows/lint.yml

@@ -0,0 +1,33 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: TypeScript type check
+        run: npx tsc --noEmit
+      
+      - name: Check for console.logs
+        run: |
+          if grep -r "console\.log" src/ --exclude-dir=node_modules; then
+            echo "Warning: console.log found in source files"
+          fi

package/.github/workflows/publish.yml

@@ -0,0 +1,82 @@
+name: Publish to npm
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    
+    permissions:
+      contents: write
+      id-token: write
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Build
+        run: npm run build
+      
+      - name: Verify build
+        run: |
+          if [ ! -d "dist" ]; then
+            echo "Build failed: dist directory not found"
+            exit 1
+          fi
+          echo "Build successful"
+      
+      - name: Get version from tag
+        id: get_version
+        run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+      
+      - name: Verify version matches package.json
+        run: |
+          TAG_VERSION="${{ steps.get_version.outputs.VERSION }}"
+          PKG_VERSION=$(node -p "require('./package.json').version")
+          if [ "$TAG_VERSION" != "$PKG_VERSION" ]; then
+            echo "Error: Tag version ($TAG_VERSION) does not match package.json version ($PKG_VERSION)"
+            echo "Please run 'npm version <type>' to update both"
+            exit 1
+          fi
+          echo "Version verified: $TAG_VERSION"
+      
+      - name: Publish to npm
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      
+      - name: Create GitHub Release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ steps.get_version.outputs.VERSION }}
+          body: |
+            ## Changes in this Release
+            
+            See [CHANGELOG.md](https://github.com/${{ github.repository }}/blob/main/CHANGELOG.md) for details.
+            
+            ## Installation
+            
+            ```bash
+            npx @daawoonkim/create-arch-app my-app
+            ```
+            
+            ## npm Package
+            https://www.npmjs.com/package/@daawoonkim/create-arch-app/v/${{ steps.get_version.outputs.VERSION }}
+          draft: false
+          prerelease: false

package/.github/workflows/test.yml

@@ -0,0 +1,52 @@
+name: PR Tests
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Build
+        run: npm run build
+      
+      - name: Check for TypeScript errors
+        run: npx tsc --noEmit
+      
+      - name: Test CLI installation
+        run: |
+          npm link
+          echo "✓ CLI linked successfully"
+      
+      - name: Verify CLI command exists
+        run: |
+          which create-arch-app
+          create-arch-app --version || echo "CLI is available"
+      
+      - name: Verify dist files
+        run: |
+          if [ -d "dist" ]; then
+            echo "✓ Build artifacts exist"
+            ls -la dist/
+          else
+            echo "✗ Build artifacts missing"
+            exit 1
+          fi

package/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2024-01-XX
+
+### Added
+- Initial MVP release
+- Support for 4 architecture patterns (DDD, Clean Architecture, Atomic Design, Default)
+- React (with Vite) and Next.js framework options
+- Next.js version selection (Latest, 15.x, 14.x, 13.x)
+- Next.js router selection (App Router, Pages Router)
+- TypeScript as default
+- Styling options: Tailwind CSS, CSS Modules
+- State management options: Zustand, Context API, None
+- Form library: React Hook Form
+- Testing: Vitest + Testing Library
+- Current directory creation support (`.` option)
+- Interactive CLI with inquirer.js
+- Automatic folder structure generation
+- README.md generation with project details
+- Environment-specific configuration files
+
+### Documentation
+- Comprehensive README with usage examples
+- Publishing guide (PUBLISHING.md)
+- Testing guide (TESTING.md)
+
+[Unreleased]: https://github.com/hec8897/create-arch-app/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/hec8897/create-arch-app/releases/tag/v0.1.0