@scrymore/scry-deployer 0.0.2

package/lib/templates.js

@@ -0,0 +1,226 @@
+/**
+ * Generate GitHub Actions workflow templates
+ */
+
+/**
+ * Get package manager setup action
+ */
+function getPackageManagerSetup(packageManager) {
+    switch (packageManager) {
+        case 'pnpm':
+            return `      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+`;
+        case 'yarn':
+            return ''; // Yarn is supported by default in setup-node
+        case 'bun':
+            return `      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+`;
+        default:
+            return '';
+    }
+}
+
+/**
+ * Get install command for package manager
+ * All commands handle missing lockfiles gracefully
+ */
+function getInstallCommand(packageManager) {
+    switch (packageManager) {
+        case 'npm':
+            // Use npm install which works with or without package-lock.json
+            return 'npm install';
+        case 'pnpm':
+            // Just use pnpm install - it works with or without lockfile
+            // We set CI=false to prevent pnpm from auto-enabling frozen-lockfile
+            return 'CI=false pnpm install';
+        case 'yarn':
+            return 'yarn install';
+        case 'bun':
+            return 'bun install';
+        default:
+            return 'npm install';
+    }
+}
+
+/**
+ * Get cache value for package manager
+ */
+function getCacheValue(packageManager) {
+    if (packageManager === 'npm') {
+        return '';
+    }
+    return `          cache: '${packageManager}'`;
+}
+
+/**
+ * Generate main deployment workflow
+ */
+function generateMainWorkflow(projectId, apiUrl, packageManager, buildCmd) {
+    const pmSetup = getPackageManagerSetup(packageManager);
+    const installCmd = getInstallCommand(packageManager);
+    const cache = getCacheValue(packageManager);
+    const runCmd = packageManager === 'npm' ? `npm run ${buildCmd}` : `${packageManager} run ${buildCmd}`;
+
+    return `# Auto-generated by Scry Storybook Deployer
+# Deploy Storybook to production on push to main branch
+
+name: Deploy Storybook
+
+on:
+  push:
+    branches: [main, master]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+${pmSetup}      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+${cache}
+
+      - name: Install dependencies
+        run: ${installCmd}
+
+      - name: Build Storybook
+        run: ${runCmd}
+
+      - name: Deploy to Scry
+        run: npx @scrymore/scry-deployer --dir ./storybook-static
+        env:
+          STORYBOOK_DEPLOYER_API_URL: \${{ vars.SCRY_API_URL }}
+          STORYBOOK_DEPLOYER_PROJECT: \${{ vars.SCRY_PROJECT_ID }}
+          STORYBOOK_DEPLOYER_API_KEY: \${{ secrets.SCRY_API_KEY }}
+`;
+}
+
+/**
+ * Generate PR preview workflow
+ */
+function generatePRWorkflow(projectId, apiUrl, packageManager, buildCmd) {
+    const pmSetup = getPackageManagerSetup(packageManager);
+    const installCmd = getInstallCommand(packageManager);
+    const cache = getCacheValue(packageManager);
+    const runCmd = packageManager === 'npm' ? `npm run ${buildCmd}` : `${packageManager} run ${buildCmd}`;
+
+    return `# Auto-generated by Scry Storybook Deployer
+# Deploy Storybook preview for pull requests
+
+name: Deploy Storybook PR Preview
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  deploy-preview:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+${pmSetup}      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+${cache}
+
+      - name: Install dependencies
+        run: ${installCmd}
+
+      - name: Build Storybook
+        run: ${runCmd}
+
+      - name: Deploy Preview
+        id: deploy
+        run: |
+          # Deploy with PR-specific version
+          npx @scrymore/scry-deployer \\
+            --dir ./storybook-static \\
+            --version pr-\${{ github.event.pull_request.number }}
+
+          # Construct deployment URL
+          PROJECT_ID="\${{ vars.SCRY_PROJECT_ID }}"
+          API_URL="\${{ vars.SCRY_API_URL }}"
+          DEPLOY_URL="\${API_URL}/\${PROJECT_ID}/pr-\${{ github.event.pull_request.number }}"
+          echo "deployment_url=\$DEPLOY_URL" >> $GITHUB_OUTPUT
+        env:
+          STORYBOOK_DEPLOYER_API_URL: \${{ vars.SCRY_API_URL }}
+          STORYBOOK_DEPLOYER_PROJECT: \${{ vars.SCRY_PROJECT_ID }}
+          STORYBOOK_DEPLOYER_API_KEY: \${{ secrets.SCRY_API_KEY }}
+
+      - name: Comment on PR
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const deploymentUrl = '\${{ steps.deploy.outputs.deployment_url }}';
+            const prNumber = context.issue.number;
+            const commitSha = context.payload.pull_request.head.sha.substring(0, 7);
+            const branch = '\${{ github.event.pull_request.head.ref }}';
+            const deployedAt = new Date().toUTCString();
+
+            const commentBody = [
+              '## 🚀 Storybook Preview Deployed',
+              '',
+              '**Preview URL:** ' + deploymentUrl,
+              '',
+              '📌 **Details:**',
+              '- **Commit:** ' + commitSha,
+              '- **Branch:** ' + branch,
+              '- **Deployed at:** ' + deployedAt,
+              '',
+              '> This preview updates automatically on each commit to this PR.'
+            ].join('\\n');
+
+            // Check if a comment from this bot already exists
+            const { data: comments } = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: prNumber,
+            });
+
+            const botComment = comments.find(comment =>
+              comment.user.type === 'Bot' &&
+              comment.body.includes('🚀 Storybook Preview Deployed')
+            );
+
+            if (botComment) {
+              // Update existing comment
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: botComment.id,
+                body: commentBody
+              });
+              console.log('Updated existing PR comment');
+            } else {
+              // Create new comment
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: prNumber,
+                body: commentBody
+              });
+              console.log('Created new PR comment');
+            }
+`;
+}
+
+module.exports = {
+    generateMainWorkflow,
+    generatePRWorkflow
+};

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@scrymore/scry-deployer",
+  "version": "0.0.2",
+  "description": "A CLI to automate the deployment of Storybook static builds.",
+  "main": "index.js",
+  "bin": {
+    "scry-deployer": "bin/cli.js",
+    "scry": "bin/cli.js",
+    "storybook-deploy": "bin/cli.js",
+    "storybook-deploy-setup": "scripts/postinstall.js"
+  },
+  "files": [
+    "bin",
+    "lib",
+    "scripts"
+  ],
+  "keywords": [
+    "storybook",
+    "deploy",
+    "cli",
+    "scry",
+    "scrymore"
+  ],
+  "author": "Scrymore",
+  "license": "ISC",
+  "type": "commonjs",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/epinnock/scry-node.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "archiver": "^7.0.1",
+    "axios": "^1.12.2",
+    "chalk": "^4.1.2",
+    "commander": "^11.1.0",
+    "form-data": "^4.0.0",
+    "inquirer": "^8.2.6",
+    "open": "^8.4.2",
+    "storycap": "^4.2.0",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@changesets/changelog-github": "^0.5.2",
+    "@changesets/cli": "^2.29.8",
+    "dotenv": "^17.2.2"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "postinstall": "node scripts/postinstall.js",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "release": "changeset publish"
+  }
+}

package/scripts/postinstall.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+const { createDefaultConfig } = require('../lib/config');
+
+console.log('🚀 Setting up storybook-deployer...');
+createDefaultConfig();
+console.log('✨ Setup complete! You can now use storybook-deployer.');