@sk8metal/michi-cli 0.8.1 → 0.8.3

package/docs/user-guide/release/ci-setup-java.md

@@ -0,0 +1,114 @@
+# Michi CI/CD設定ガイド - Java/Gradle
+
+**親ドキュメント**: [ci-setup.md](./ci-setup.md)
+
+---
+
+## Java（Gradle）プロジェクトのCI/CD設定
+
+### GitHub Actions設定例
+
+**設定ファイル例**: `.github/workflows/test.yml`
+
+```yaml
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        java-version: [17, 21]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: ${{ matrix.java-version }}
+          cache: 'gradle'
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Run checkstyle
+        run: ./gradlew checkstyleMain checkstyleTest
+
+      - name: Run tests
+        run: ./gradlew test
+
+      - name: Build
+        run: ./gradlew build
+
+      - name: Upload test results
+        uses: actions/upload-artifact@v3
+        if: failure()
+        with:
+          name: test-results
+          path: build/reports/tests/test/
+```
+
+### Screwdriver設定例
+
+**設定ファイル例**: `screwdriver.yaml`
+
+```yaml
+shared:
+  image: openjdk:17
+
+jobs:
+  main:
+    requires: [~pr, ~commit]
+    steps:
+      - setup: chmod +x gradlew
+      - checkstyle: ./gradlew checkstyleMain checkstyleTest
+      - test: ./gradlew test
+      - build: ./gradlew build
+      - report: |
+          if [ -d "build/reports" ]; then
+            echo "Test reports generated"
+          fi
+```
+
+### build.gradle設定
+
+```gradle
+plugins {
+    id 'java'
+    id 'checkstyle'
+    id 'jacoco'
+}
+
+test {
+    useJUnitPlatform()
+    testLogging {
+        events "passed", "skipped", "failed"
+    }
+}
+
+jacoco {
+    toolVersion = "0.8.10"
+}
+
+jacocoTestReport {
+    reports {
+        xml.required = true
+        html.required = true
+    }
+}
+
+checkstyle {
+    toolVersion = '10.12.0'
+    configFile = file("${rootDir}/config/checkstyle/checkstyle.xml")
+}
+```
+

package/docs/user-guide/release/ci-setup-nodejs.md

@@ -0,0 +1,94 @@
+# Michi CI/CD設定ガイド - Node.js/TypeScript
+
+**親ドキュメント**: [ci-setup.md](./ci-setup.md)
+
+---
+
+## Node.js/TypeScript プロジェクトのCI/CD設定
+
+### GitHub Actions設定例
+
+**設定ファイル例**: `.github/workflows/test.yml`
+
+```yaml
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run lint
+        run: npm run lint
+
+      - name: Run tests
+        run: npm test
+
+      - name: Build
+        run: npm run build
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v5.5.1
+        if: matrix.node-version == '20.x'
+        with:
+          files: ./coverage/coverage-final.json
+```
+
+### Screwdriver設定例
+
+**設定ファイル例**: `screwdriver.yaml`
+
+```yaml
+shared:
+  image: node:20
+
+jobs:
+  main:
+    requires: [~pr, ~commit]
+    steps:
+      - install: npm ci
+      - lint: npm run lint
+      - test: npm test
+      - build: npm run build
+      - coverage: |
+          if [ -d "coverage" ]; then
+            echo "Coverage report generated"
+          fi
+```
+
+### package.jsonスクリプト設定
+
+```json
+{
+  "scripts": {
+    "test": "vitest run --coverage",
+    "test:watch": "vitest",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "build": "tsc",
+    "type-check": "tsc --noEmit"
+  }
+}
+```
+

package/docs/user-guide/release/ci-setup-php.md

@@ -0,0 +1,102 @@
+# Michi CI/CD設定ガイド - PHP
+
+**親ドキュメント**: [ci-setup.md](./ci-setup.md)
+
+---
+
+## PHP プロジェクトのCI/CD設定
+
+### GitHub Actions設定例
+
+**設定ファイル例**: `.github/workflows/test.yml`
+
+```yaml
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php-version: ['8.1', '8.2', '8.3']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          coverage: xdebug
+          tools: composer:v2
+
+      - name: Cache Composer packages
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run PHPStan
+        run: composer phpstan
+
+      - name: Run tests
+        run: composer test
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v5.5.1
+        if: matrix.php-version == '8.3'
+        with:
+          files: ./coverage.xml
+```
+
+### Screwdriver設定例
+
+**設定ファイル例**: `screwdriver.yaml`
+
+```yaml
+shared:
+  image: php:8.3
+
+jobs:
+  main:
+    requires: [~pr, ~commit]
+    steps:
+      - install-composer: |
+          php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
+          php composer-setup.php
+          php -r "unlink('composer-setup.php');"
+      - install: php composer.phar install --prefer-dist --no-progress
+      - phpstan: php composer.phar phpstan
+      - test: php composer.phar test
+```
+
+### composer.json設定
+
+```json
+{
+  "scripts": {
+    "test": "phpunit --coverage-clover coverage.xml",
+    "test:unit": "phpunit --testsuite Unit",
+    "phpstan": "phpstan analyse src tests --level=8",
+    "cs-fix": "php-cs-fixer fix"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^10.0",
+    "phpstan/phpstan": "^1.10",
+    "friendsofphp/php-cs-fixer": "^3.0"
+  }
+}
+```
+

package/docs/user-guide/release/ci-setup-troubleshooting.md

@@ -0,0 +1,94 @@
+# Michi CI/CD - トラブルシューティング
+
+**親ドキュメント**: [ci-setup.md](./ci-setup.md)
+
+---
+
+## トラブルシューティング
+
+### Node.js関連
+
+#### 問題: `npm ci` が失敗する
+
+**原因**: package-lock.jsonが古い
+
+**解決方法**:
+```bash
+# ローカルで再生成
+rm -rf node_modules package-lock.json
+npm install
+git add package-lock.json
+git commit -m "fix: update package-lock.json"
+```
+
+#### 問題: テストがローカルでは成功するがCI/CDで失敗
+
+**原因**: 環境依存の問題（タイムゾーン、ファイルパス等）
+
+**解決方法**:
+```javascript
+// タイムゾーンを固定
+process.env.TZ = 'UTC';
+
+// ファイルパスは絶対パスではなく相対パス
+const configPath = path.join(__dirname, '../config.json');
+```
+
+### Java（Gradle）関連
+
+#### 問題: Gradleビルドが遅い
+
+**原因**: キャッシュが効いていない
+
+**解決方法**:
+```yaml
+# GitHub Actionsでキャッシュを有効化
+- uses: actions/setup-java@v4
+  with:
+    cache: 'gradle'
+
+# または手動でキャッシュ
+- uses: actions/cache@v3
+  with:
+    path: |
+      ~/.gradle/caches
+      ~/.gradle/wrapper
+    key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+```
+
+#### 問題: `./gradlew: Permission denied`
+
+**原因**: 実行権限がない
+
+**解決方法**:
+```yaml
+- name: Grant execute permission
+  run: chmod +x gradlew
+```
+
+### PHP関連
+
+#### 問題: Composer installが失敗
+
+**原因**: メモリ不足
+
+**解決方法**:
+```yaml
+- name: Install dependencies
+  run: composer install --prefer-dist --no-progress
+  env:
+    COMPOSER_MEMORY_LIMIT: -1
+```
+
+#### 問題: PHPStanがCI/CDで異なる結果を返す
+
+**原因**: PHPバージョンの違い
+
+**解決方法**:
+```yaml
+# 特定のPHPバージョンを指定
+- uses: shivammathur/setup-php@v2
+  with:
+    php-version: '8.3'  # プロジェクトと同じバージョン
+```
+