@scrymore/scry-deployer 0.0.2 → 0.0.4

package/README.md

@@ -5,7 +5,7 @@ Deploy your Storybook to the cloud with one command. ⚡
 ## 🎯 Quick Start (5 seconds)
 
 ### 1. Get your credentials
-Visit the [Scry Dashboard](https://dashboard.scry.com) and:
+Visit the [Scry Dashboard](https://dashboard.scrymore.com) and:
 - 🔐 Login with your account (Firebase)
 - 📦 Create a new project
 - 📋 Copy your **Project ID** and **API Key**
@@ -13,7 +13,7 @@ Visit the [Scry Dashboard](https://dashboard.scry.com) and:
 ### 2. Run the setup command
 
 ```bash
-npx @scry/storybook-deployer init --projectId YOUR_PROJECT_ID --apiKey YOUR_API_KEY
+npx @scrymore/scry-deployer init --projectId YOUR_PROJECT_ID --apiKey YOUR_API_KEY
 ```
 
 **That's it!** 🎉
@@ -61,7 +61,7 @@ This tool is designed for execution within a CI/CD pipeline (such as GitHub Acti
 Want to test a deployment before setting up automation? Run:
 
 ```bash
-npx @scry/storybook-deployer --dir ./storybook-static --project YOUR_PROJECT_ID --api-key YOUR_API_KEY
+npx @scrymore/scry-deployer --dir ./storybook-static --project YOUR_PROJECT_ID --api-key YOUR_API_KEY
 ```
 
 This deploys your Storybook immediately without setting up GitHub Actions.
@@ -74,7 +74,7 @@ This deploys your Storybook immediately without setting up GitHub Actions.
 
 ```bash
 # From npm (recommended)
-npx @scry/storybook-deployer init --projectId xxx --apiKey yyy
+npx @scrymore/scry-deployer init --projectId xxx --apiKey yyy
 
 # From GitHub (latest from main branch)
 npx github:epinnock/scry-node init --projectId xxx --apiKey yyy
@@ -86,7 +86,7 @@ If you prefer to install it as a development dependency:
 
 ```bash
 # From npm (when published)
-npm install @scry/storybook-deployer --save-dev
+npm install @scrymore/scry-deployer --save-dev
 
 # From GitHub
 npm install github:epinnock/scry-node --save-dev
@@ -406,7 +406,7 @@ If you're installing from GitHub, the workflow file is already included.
 | `SCRY_API_URL` | Backend API endpoint for uploads | `https://api.scrymore.com` |
 | `SCRY_VIEW_URL` | Base URL where users view deployed Storybooks | `https://view.scrymore.com` |
 
-**Note:** The `SCRY_VIEW_URL` is where users will access your deployed Storybook (e.g., `https://view.scrymore.com/{project}/pr-{number}`). This is separate from `SCRY_API_URL`, which is the backend API endpoint used for uploads.
+**Note:** The `SCRY_VIEW_URL` is where users will access your deployed Storybook (e.g., `https://view.scrymore.com/{project}/pr-{number}/`). This is separate from `SCRY_API_URL`, which is the backend API endpoint used for uploads.
 
 **Step 3: Configure GitHub Actions Secrets (Optional)**
 
@@ -444,14 +444,14 @@ If your build command is different, update line 29 in `.github/workflows/deploy-
 
 The workflow constructs deployment URLs using the `SCRY_VIEW_URL` variable:
 ```
-{SCRY_VIEW_URL}/{PROJECT_ID}/pr-{PR_NUMBER}
+{SCRY_VIEW_URL}/{PROJECT_ID}/pr-{PR_NUMBER}/
 ```
 
 **Default:** If `SCRY_VIEW_URL` is not set, it defaults to `https://view.scrymore.com`
 
 **Example URLs:**
-- With default: `https://view.scrymore.com/my-project/pr-123`
-- With custom domain: `https://storybooks.mycompany.com/my-project/pr-123`
+- With default: `https://view.scrymore.com/my-project/pr-123/`
+- With custom domain: `https://storybooks.mycompany.com/my-project/pr-123/`
 
 To use a custom domain, add `SCRY_VIEW_URL` as a repository variable (see Step 2).
 
@@ -515,7 +515,7 @@ The CLI also supports these environment variables for backward compatibility:
 ```markdown
 ## 🚀 Storybook Preview Deployed
 
-**Preview URL:** https://view.scrymore.com/my-project/pr-123
+**Preview URL:** https://view.scrymore.com/my-project/pr-123/
 
 📌 **Details:**
 - **Commit:** `abc1234`
@@ -839,7 +839,7 @@ gh auth login
 
 Or skip GitHub CLI setup and set variables manually:
 ```bash
-npx @scry/storybook-deployer init --projectId xxx --apiKey yyy --skip-gh-setup
+npx @scrymore/scry-deployer init --projectId xxx --apiKey yyy --skip-gh-setup
 ```
 
 Then manually add variables in GitHub Settings → Secrets and variables → Actions.
@@ -881,6 +881,64 @@ git push
 
 ---
 
+## 👩‍💻 Contributing & Development
+
+We use [Changesets](https://github.com/changesets/changesets) for version management and releases.
+
+### Development Workflow
+
+```bash
+# 1. Create a feature branch
+git checkout main && git pull
+git checkout -b feature/my-new-feature
+
+# 2. Make your changes
+# ... edit files ...
+
+# 3. Create a changeset (if your changes should be released)
+pnpm changeset
+# Select @scrymore/scry-deployer
+# Choose: patch (bug fix), minor (feature), major (breaking)
+# Write a description of your changes
+
+# 4. Commit everything
+git add .
+git commit -m "feat: add new feature"
+
+# 5. Push and create a PR
+git push -u origin HEAD
+```
+
+### When to Create a Changeset
+
+| Change Type | Changeset? | Version Bump |
+|-------------|------------|--------------|
+| Bug fix | ✅ Yes | `patch` (0.0.1 → 0.0.2) |
+| New feature | ✅ Yes | `minor` (0.0.2 → 0.1.0) |
+| Breaking change | ✅ Yes | `major` (0.1.0 → 1.0.0) |
+| Documentation only | ❌ No | - |
+| CI/workflow changes | ❌ No | - |
+
+### Release Process
+
+1. **Merge PR to main** → Release workflow runs
+2. **Changesets bot creates "Version Packages" PR** → Updates version + CHANGELOG
+3. **Merge Version PR** → Publishes to npm automatically
+
+### Installing Development Versions
+
+```bash
+# Stable release (recommended)
+npm install @scrymore/scry-deployer
+
+# Nightly release (latest from main, published daily)
+npm install @scrymore/scry-deployer@nightly
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed contribution guidelines.
+
+---
+
 ## 🆘 Support
 
 Need help?

package/lib/init.js

@@ -351,6 +351,7 @@ If you haven't already, set up these repository variables:
 3. Add these Variables (Variables tab):
    • SCRY_PROJECT_ID = ${projectId}
    • SCRY_API_URL = ${apiUrl}
+   • SCRY_VIEW_URL = https://view.scrymore.com (optional, defaults to this)
 
 4. Add this Secret (Secrets tab):
    • SCRY_API_KEY = ${apiKey}
@@ -358,6 +359,7 @@ If you haven't already, set up these repository variables:
 Or install GitHub CLI and run:
    gh variable set SCRY_PROJECT_ID --body "${projectId}"
    gh variable set SCRY_API_URL --body "${apiUrl}"
+   gh variable set SCRY_VIEW_URL --body "https://view.scrymore.com"
    gh secret set SCRY_API_KEY --body "${apiKey}"
 `);
 }
@@ -465,8 +467,8 @@ ${!pushed ? `
    • Every pull request (as a preview)
 
 🌐 Deployment URLs:
-   • Production: ${apiUrl}/${projectId}/latest
-   • PR Previews: ${apiUrl}/${projectId}/pr-{number}
+   • Production: https://view.scrymore.com/${projectId}/latest/
+   • PR Previews: https://view.scrymore.com/${projectId}/pr-{number}/
 
 📖 Learn more: https://github.com/epinnock/scry-node
 💬 Need help? Open an issue on GitHub

package/lib/templates.js

@@ -153,10 +153,11 @@ ${cache}
             --dir ./storybook-static \\
             --version pr-\${{ github.event.pull_request.number }}
 
-          # Construct deployment URL
+          # Construct deployment URL using VIEW_URL (where users access the deployed Storybook)
+          # Defaults to https://view.scrymore.com if SCRY_VIEW_URL is not set
           PROJECT_ID="\${{ vars.SCRY_PROJECT_ID }}"
-          API_URL="\${{ vars.SCRY_API_URL }}"
-          DEPLOY_URL="\${API_URL}/\${PROJECT_ID}/pr-\${{ github.event.pull_request.number }}"
+          VIEW_URL="\${{ vars.SCRY_VIEW_URL || 'https://view.scrymore.com' }}"
+          DEPLOY_URL="\${VIEW_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 }}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrymore/scry-deployer",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "A CLI to automate the deployment of Storybook static builds.",
   "main": "index.js",
   "bin": {