@by-association-only/theme-backup 1.0.2 → 1.0.4

package/.github/workflows/npm-publish.yml

@@ -1,20 +1,99 @@
+# Releases a new version whenever a PR is merged into main:
+# bumps the version, publishes to npm, then pushes the version commit and tag and creates a GitHub release.
+#
+# Version bump defaults to patch. Add one of these labels to the PR to change it:
+#   release:minor, release:major - bump minor / major instead
+#   skip-release                  - don't release this merge
+# Merges that only change *.md files or .github/ don't release.
+#
+# Can also be run by hand from the Actions tab (Run workflow) to release the current main.
+#
+# npm authenticates via trusted publishing (OIDC), configured on npmjs.com for this workflow filename.
 name: Publish package to npm
 on:
-  release:
-    types: [published]
+  push:
+    branches: [main]
+    paths-ignore:
+      - '**.md'
+      - '.github/**'
+  workflow_dispatch:
+    inputs:
+      bump:
+        description: Version bump
+        type: choice
+        options: [patch, minor, major]
+        default: patch
+# Queue releases so two quick merges don't race to push the same version
+concurrency:
+  group: release
+  cancel-in-progress: false
 jobs:
-  build:
+  release:
+    if: github.ref_name == github.event.repository.default_branch
     runs-on: ubuntu-latest
     permissions:
-      contents: read
+      contents: write
       id-token: write
+      pull-requests: read
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v7
+        with:
+          # Latest branch tip rather than the triggering commit, so a queued run includes earlier release commits
+          ref: ${{ github.ref_name }}
+      - uses: actions/setup-node@v7
         with:
-          node-version: '20.x'
+          node-version: '24'
           registry-url: 'https://registry.npmjs.org'
-      - run: npm ci
-      - run: npm publish --access public
+          package-manager-cache: false
+      - name: Choose version bump
+        id: bump
+        env:
+          GH_TOKEN: ${{ github.token }}
+          INPUT_BUMP: ${{ inputs.bump }}
+        run: |
+          if [ "$GITHUB_EVENT_NAME" = "workflow_dispatch" ]; then
+            bump="$INPUT_BUMP"
+          else
+            labels=$(gh api "repos/$GITHUB_REPOSITORY/commits/$GITHUB_SHA/pulls" -q '.[0].labels[].name')
+            bump=patch
+            if grep -qx 'release:minor' <<< "$labels"; then bump=minor; fi
+            if grep -qx 'release:major' <<< "$labels"; then bump=major; fi
+            if grep -qx 'skip-release' <<< "$labels"; then bump=skip; fi
+          fi
+          echo "Version bump: $bump"
+          echo "bump=$bump" >> "$GITHUB_OUTPUT"
+      - if: steps.bump.outputs.bump != 'skip'
+        run: npm ci
+      - name: Bump version
+        id: version
+        if: steps.bump.outputs.bump != 'skip'
+        env:
+          BUMP: ${{ steps.bump.outputs.bump }}
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+          name=$(node -p "require('./package.json').name")
+          current=$(node -p "require('./package.json').version")
+          if npm view "$name@$current" version > /dev/null 2>&1; then
+            # Commits the bumped package.json / package-lock.json and tags it v<version>
+            npm version "$BUMP" -m 'chore: Release v%s'
+          else
+            # The version was already bumped by hand and isn't on npm yet, so release it as-is
+            echo "$name@$current isn't on npm yet, releasing it without a bump"
+            git tag "v$current"
+          fi
+          echo "tag=v$(node -p "require('./package.json').version")" >> "$GITHUB_OUTPUT"
+      # Publish before pushing, so if npm rejects it nothing reaches git and the run can be retried
+      - if: steps.bump.outputs.bump != 'skip'
+        run: npm publish --access public
+      - name: Push version commit and tag
+        if: steps.bump.outputs.bump != 'skip'
+        env:
+          TAG: ${{ steps.version.outputs.tag }}
+        run: git push --atomic origin "HEAD:$GITHUB_REF_NAME" "$TAG"
+      - name: Create GitHub release
+        if: steps.bump.outputs.bump != 'skip'
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.npm_token }}
+          GH_TOKEN: ${{ github.token }}
+          TAG: ${{ steps.version.outputs.tag }}
+        run: gh release create "$TAG" --title "$TAG" --generate-notes --verify-tag

package/README.md

@@ -78,3 +78,12 @@ shopify auth login
 ### Theme Limit Errors
 
 If you're at the theme limit, the tool will prompt you to delete themes before proceeding.
+
+## Releasing
+
+Merging a PR into `main` publishes a new version automatically. The GitHub Action bumps the version, publishes to npm, and creates the version tag and a GitHub release with notes.
+
+- The version bump is **patch** by default. Add a `release:minor` or `release:major` label to the PR to change it, or `skip-release` to not release that merge.
+- Merges that only change `*.md` files or `.github/` don't release.
+- If the PR already bumps `version` in `package.json` to a version that isn't on npm yet, that version is released as-is.
+- To release by hand, run the **Publish package to npm** workflow from the Actions tab and choose the bump.

package/index.js

@@ -2,7 +2,31 @@
 import fs from 'node:fs'
 import path from 'node:path'
 import chalk from 'chalk'
-import { execSync } from 'node:child_process'
+import { execFileSync, execSync } from 'node:child_process'
+
+// Function to run a Shopify CLI command
+// Arguments are passed without a shell so theme names and paths containing quotes, $ or spaces aren't mangled.
+// Windows can't run shopify.cmd without a shell, so each argument is quoted there instead.
+function shopify(args, options) {
+  if (process.platform === 'win32') {
+    return execSync(`shopify ${args.map(arg => `"${arg}"`).join(' ')}`, options)
+  }
+  return execFileSync('shopify', args, options)
+}
+
+// Enable raw mode for real-time input, removing any previous prompt's key listener first.
+// Listeners left attached keep reacting to key presses, e.g. the Y/N prompt pausing input when typing a search.
+function startInput() {
+  process.stdin.removeAllListeners('data')
+  process.stdin.setRawMode(true)
+  process.stdin.resume()
+}
+
+function stopInput() {
+  process.stdin.removeAllListeners('data')
+  process.stdin.setRawMode(false)
+  process.stdin.pause()
+}
 
 // Function to read stores from config file
 function readStoresFromConfig() {
@@ -39,7 +63,7 @@ function readStoresFromConfig() {
 async function getStoreThemes(store) {
   try {
     console.log(chalk.gray(`  Fetching themes from ${store}...`))
-    const output = execSync(`shopify theme list -s=${store} --json`, {
+    const output = shopify(['theme', 'list', `-s=${store}`, '--json'], {
       encoding: 'utf8',
       stdio: ['pipe', 'pipe', 'pipe'] // Silent mode since auth is already handled
     })
@@ -76,8 +100,7 @@ async function selectTheme(store, actionText = 'Please select theme to backup')
   let searchTerm = ''
 
   // Enable raw mode for real-time input
-  process.stdin.setRawMode(true)
-  process.stdin.resume()
+  startInput()
 
   const clearScreen = () => {
     process.stdout.write('\x1B[2J\x1B[H')
@@ -153,24 +176,21 @@ async function selectTheme(store, actionText = 'Please select theme to backup')
   return new Promise((resolve) => {
     const handleKey = (key) => {
       if (key === '\x03' || key === 'q') { // Ctrl+C or 'q'
-        process.stdin.setRawMode(false)
-        process.stdin.pause()
+        stopInput()
         console.log(chalk.yellow('\nQuitting theme backup...'))
         process.exit(0)
         return
       }
 
       if (key === 's') { // Skip store
-        process.stdin.setRawMode(false)
-        process.stdin.pause()
+        stopInput()
         console.log(chalk.yellow(`\nSkipping ${store}...`))
         resolve(null)
         return
       }
 
       if (key === '\r') { // Enter
-        process.stdin.setRawMode(false)
-        process.stdin.pause()
+        stopInput()
         const sortedThemes = getSortedThemes()
         resolve(sortedThemes[selectedIndex])
         return
@@ -229,8 +249,7 @@ async function selectThemesToDelete(store, themes, requiredCount = 1) {
   let errorMessage = ''
 
   // Enable raw mode for real-time input
-  process.stdin.setRawMode(true)
-  process.stdin.resume()
+  startInput()
 
   const clearScreen = () => {
     process.stdout.write('\x1B[2J\x1B[H')
@@ -307,8 +326,7 @@ async function selectThemesToDelete(store, themes, requiredCount = 1) {
   return new Promise((resolve) => {
     const handleKey = (key) => {
       if (key === '\x03' || key === 'q') { // Ctrl+C or 'q'
-        process.stdin.setRawMode(false)
-        process.stdin.pause()
+        stopInput()
         console.log(chalk.yellow('\nQuitting theme backup...'))
         process.exit(0)
         return
@@ -316,8 +334,7 @@ async function selectThemesToDelete(store, themes, requiredCount = 1) {
 
       if (key === '\r') { // Enter
         if (requiredCount === 0 || selectedIndices.size >= requiredCount) {
-          process.stdin.setRawMode(false)
-          process.stdin.pause()
+          stopInput()
           const themesToDelete = Array.from(selectedIndices).map(i => filteredThemes[i])
           resolve(themesToDelete)
           return
@@ -394,7 +411,7 @@ async function deleteThemes(store, themes) {
   for (const theme of themes) {
     try {
       console.log(chalk.gray(`  Deleting: ${theme.name} (ID: ${theme.id})`))
-      execSync(`shopify theme delete -t=${theme.id} -s=${store} --force`, { stdio: 'inherit' })
+      shopify(['theme', 'delete', `-t=${theme.id}`, `-s=${store}`, '--force'], { stdio: 'inherit' })
       console.log(chalk.green(`  ✓ Deleted: ${theme.name}`))
     } catch (error) {
       console.error(chalk.red(`  ✗ Failed to delete ${theme.name}:`))
@@ -430,10 +447,10 @@ async function backupTheme(store, theme) {
     fs.mkdirSync(tempPath, { recursive: true })
 
     console.log(chalk.gray(`\nPulling theme: ${theme.name}...`))
-    execSync(`shopify theme pull -t=${theme.id} -s=${store} --path ${tempPath}`, { stdio: 'inherit' })
+    shopify(['theme', 'pull', `-t=${theme.id}`, `-s=${store}`, '--path', tempPath], { stdio: 'inherit' })
 
     console.log(chalk.gray(`\nPushing as new theme: ${backupName}...`))
-    execSync(`shopify theme push -s=${store} --unpublished --path ${tempPath} --theme="${backupName}"`, { stdio: 'inherit' })
+    shopify(['theme', 'push', `-s=${store}`, '--unpublished', '--path', tempPath, `--theme=${backupName}`], { stdio: 'inherit' })
 
     console.log(chalk.green(`\n✓ Successfully backed up theme: ${theme.name}`))
     console.log(chalk.gray(`  New theme: ${backupName}`))
@@ -457,10 +474,7 @@ async function backupTheme(store, theme) {
 
 // Function to prompt user for text input
 async function promptTextInput(message, maxLength = 50) {
-  // Remove all existing listeners to prevent conflicts
-  process.stdin.removeAllListeners('data')
-  process.stdin.setRawMode(true)
-  process.stdin.resume()
+  startInput()
 
   let input = ''
 
@@ -482,9 +496,7 @@ async function promptTextInput(message, maxLength = 50) {
       const key = data.toString()
 
       if (key === '\x03') { // Ctrl+C
-        process.stdin.removeAllListeners('data')
-        process.stdin.setRawMode(false)
-        process.stdin.pause()
+        stopInput()
         console.log(chalk.yellow('\nCancelled...'))
         process.exit(0)
         return
@@ -499,9 +511,7 @@ async function promptTextInput(message, maxLength = 50) {
           updateDisplay()
           return
         }
-        process.stdin.removeAllListeners('data')
-        process.stdin.setRawMode(false)
-        process.stdin.pause()
+        stopInput()
         resolve(input.trim())
         return
       }
@@ -521,8 +531,7 @@ async function promptTextInput(message, maxLength = 50) {
 
 // Function to prompt user for yes/no
 async function promptYesNo(message) {
-  process.stdin.setRawMode(true)
-  process.stdin.resume()
+  startInput()
 
   console.log(chalk.yellow(`\n${message}`))
   console.log(chalk.gray('Press Y for Yes, N for No'))
@@ -532,22 +541,19 @@ async function promptYesNo(message) {
       const keyStr = key.toString().toLowerCase()
 
       if (keyStr === 'y') {
-        process.stdin.setRawMode(false)
-        process.stdin.pause()
+        stopInput()
         resolve(true)
         return
       }
 
       if (keyStr === 'n') {
-        process.stdin.setRawMode(false)
-        process.stdin.pause()
+        stopInput()
         resolve(false)
         return
       }
 
       if (key === '\x03') { // Ctrl+C
-        process.stdin.setRawMode(false)
-        process.stdin.pause()
+        stopInput()
         console.log(chalk.yellow('\nQuitting...'))
         process.exit(0)
       }
@@ -561,7 +567,7 @@ async function promptYesNo(message) {
 async function checkAuthentication(store) {
   try {
     console.log(chalk.gray(`Checking authentication for ${store}...`))
-    execSync(`shopify theme info -s=${store}`, {
+    shopify(['theme', 'info', `-s=${store}`], {
       encoding: 'utf8',
       stdio: 'inherit' // Allow interactive authentication
     })
@@ -590,6 +596,9 @@ async function runBackup() {
     console.log(chalk.green('✓ Authentication verified\n'))
   }
 
+  // Stores whose backup failed, listed at the end as the screen is cleared between stores
+  const failedStores = []
+
   for (let i = 0; i < stores.length; i++) {
     const store = stores[i]
 
@@ -606,6 +615,7 @@ async function runBackup() {
     const themes = await getStoreThemes(store)
     if (!themes) {
       console.error(chalk.red('Failed to fetch themes, skipping store'))
+      failedStores.push(store)
       continue
     }
 
@@ -623,6 +633,7 @@ async function runBackup() {
       const deleteSuccess = await deleteThemes(store, themesToDelete)
       if (!deleteSuccess) {
         console.log(chalk.red('Failed to delete themes, skipping store'))
+        failedStores.push(store)
         continue
       }
 
@@ -656,7 +667,21 @@ async function runBackup() {
     }
 
     // Backup the theme
-    await backupTheme(store, selectedTheme)
+    const backupSuccess = await backupTheme(store, selectedTheme)
+    if (!backupSuccess) {
+      failedStores.push(store)
+    }
+  }
+
+  if (failedStores.length > 0) {
+    console.log(chalk.bold.red('\n---------------------------------'))
+    console.log(chalk.bold.red(`✗ BACKUP FAILED FOR ${failedStores.length} STORE(S)`))
+    console.log(chalk.bold.red('---------------------------------'))
+    for (const store of failedStores) {
+      console.log(chalk.red(`  ${store}`))
+    }
+    console.log('')
+    process.exit(1)
   }
 
   console.log(chalk.bold('\n---------------------------------'))
@@ -664,4 +689,7 @@ async function runBackup() {
   console.log(chalk.bold('---------------------------------\n'))
 }
 
-runBackup().catch(console.error)
+runBackup().catch((error) => {
+  console.error(error)
+  process.exit(1)
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@by-association-only/theme-backup",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Backup Shopify themes across multiple stores.",
   "type": "module",
   "main": "index.js",
@@ -25,4 +25,3 @@
   "homepage": "https://github.com/baoagency/theme-backup#readme",
   "devDependencies": {}
 }
-