deploy-docs

ドキュメントのデプロイコマンド

ドキュメントサイトを検証し、GitHub Pages へのデプロイに備えます。

手順 1：ドキュメントを検証する

次のチェックを実行します。

# Count components
echo "Agents: $(ls plugins/compound-engineering/agents/*.md | wc -l)"
echo "Skills: $(ls -d plugins/compound-engineering/skills/*/ 2>/dev/null | wc -l)"

# Validate JSON
cat .claude-plugin/marketplace.json | jq . > /dev/null && echo "✓ marketplace.json valid"
cat plugins/compound-engineering/.claude-plugin/plugin.json | jq . > /dev/null && echo "✓ plugin.json valid"

# Check all HTML files exist
for page in index agents commands skills mcp-servers changelog getting-started; do
  if [ -f "plugins/compound-engineering/docs/pages/${page}.html" ] || [ -f "plugins/compound-engineering/docs/${page}.html" ]; then
    echo "✓ ${page}.html exists"
  else
    echo "✗ ${page}.html MISSING"
  fi
done

手順 2：コミットされていない変更を確認する

git status --porcelain plugins/compound-engineering/docs/

コミットされていない変更がある場合は、先にコミットするようユーザーに警告します。

手順 3：デプロイ手順

GitHub Pages へのデプロイには、特別な権限を持つワークフローファイルが必要なため、次の手順を案内します。

初回のセットアップ

1. GitHub Pages ワークフローを含む .github/workflows/deploy-docs.yml を作成します
2. リポジトリの Settings > Pages に移動します
3. Source を「GitHub Actions」に設定します

デプロイ

main にマージすると、ドキュメントは自動的にデプロイされます。または、次の手順を実行します。

1. Actions タブに移動します
2. 「Deploy Documentation to GitHub Pages」を選択します
3. 「Run workflow」をクリックします

ワークフローファイルの内容

name: Deploy Documentation to GitHub Pages

on:
  push:
    branches: [main]
    paths:
      - 'plugins/compound-engineering/docs/**'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/configure-pages@v4
      - uses: actions/upload-pages-artifact@v3
        with:
          path: 'plugins/compound-engineering/docs'
      - uses: actions/deploy-pages@v4

手順 4：ステータスを報告する

概要を提示します。

## Deployment Readiness

✓ All HTML pages present
✓ JSON files valid
✓ Component counts match

### Next Steps
- [ ] Commit any pending changes
- [ ] Push to main branch
- [ ] Verify GitHub Pages workflow exists
- [ ] Check deployment at https://everyinc.github.io/compound-engineering-plugin/