npm-workspaces-publish-tool 0.0.15 → 0.0.17

package/README.md

@@ -23,13 +23,16 @@ npm install -g npm-workspaces-publish-tool
 ## Usage
 
 ```bash
-nw-publish [--dry-run] [--registry <url>]
+nw-publish [--dry-run] [--registry <url>] [--auto-tick] [--anchor-tag-suffix <suffix>] [--allow-no-upstream]
 ```
 
 ### Command Options
 
 - `--dry-run`: Runs validation and preview without actual publishing
 - `--registry <url>`: (Optional) NPM registry URL to publish scoped packages to
+- `--auto-tick`: Automatically increment patch versions for packages that need version bumps
+- `--anchor-tag-suffix <suffix>`: (Optional) Suffix to append to git tags (e.g., `-rc` creates tags like `v1.2.3-rc`)
+- `--allow-no-upstream`: Allow publishing from branches without upstream tracking (see [CI/CD Usage](#cicd-usage))
 
 ## Workflow
 1. **Validation Phase**
@@ -43,6 +46,39 @@ nw-publish [--dry-run] [--registry <url>]
    - Publishes packages in topological order
    - Restores original `package.json` files after publishing
 
+## CI/CD Usage
+
+### Publishing from New Branches
+
+By default, the tool requires branches to have upstream tracking configured (via `git push -u origin <branch>`). This is a safety check for manual usage to prevent accidentally publishing from local-only branches.
+
+However, in CI/CD pipelines that create new release branches dynamically, you can use the `--allow-no-upstream` flag:
+
+```bash
+# CI/CD pipeline example
+nw-publish --allow-no-upstream --anchor-tag-suffix=-rc
+```
+
+**When the flag is set:**
+- The tool will automatically set upstream tracking when pushing tags
+- No manual `git push -u` is required beforehand
+- The branch and tags will be pushed together
+
+**When to use:**
+- CI/CD pipelines that create new release branches (e.g., `RELEASE/v1.2.3`)
+- Automated release workflows where the branch doesn't exist on remote yet
+
+**When not to use:**
+- Manual publishing from your local machine (push your branch first instead)
+
+**Safety notes:**
+- The flag only bypasses the "no upstream" check
+- The tool still validates:
+  - Clean git status (no uncommitted changes)
+  - Unpushed commits (if upstream exists)
+  - Version increments
+  - Build success
+
 ## Requirements
 - Node.js 16+
 - Git

package/build/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-workspaces-publish-tool",
-    "version": "0.0.15",
+    "version": "0.0.17",
     "description": "An unopinionated tool to assist publishing of npm based mono-repo workspaces",
     "main": "build/src/cli.js",
     "type": "module",

package/build/src/cli.js

@@ -123,7 +123,7 @@ function getDirtyMap(workspaces, lastTag, cwd) {
     }
     return dirtyMap;
 }
-function checkForUnpushedCommits(cwd, autoTick) {
+function checkForUnpushedCommits(cwd, autoTick, allowNoUpstream) {
     const branchResult = git(['rev-parse', '--abbrev-ref', 'HEAD'], { cwd });
     if (!branchResult.success) {
         console.error('ERROR: Could not determine current branch.');
@@ -141,8 +141,14 @@ function checkForUnpushedCommits(cwd, autoTick) {
             console.log(`ℹ️ Branch '${currentBranch}' has no upstream. Will set it during push.`);
             return true;
         }
-        // In manual mode without auto-tick, require upstream to catch mistakes
+        // If --allow-no-upstream is set, allow new branches (for CI/CD pipelines)
+        if (allowNoUpstream) {
+            console.warn(`⚠️  Branch '${currentBranch}' has no upstream. Upstream will be set automatically when pushing tags.`);
+            return true;
+        }
+        // In manual mode, require upstream to catch mistakes
         console.error(`ERROR: Branch '${currentBranch}' has no upstream.`);
+        console.error(`Please push your branch first, or use --allow-no-upstream if this is intentional.`);
         return false;
     }
     const upstream = upstreamResult.stdout.trim();
@@ -158,7 +164,7 @@ function checkForUnpushedCommits(cwd, autoTick) {
 /**
  * Check git status for uncommitted changes
  */
-function checkGitStatus(workspaces, dirtyMap, cwd, dryRun, autoTick) {
+function checkGitStatus(workspaces, dirtyMap, cwd, dryRun, autoTick, allowNoUpstream) {
     const stagedFilesRaw = git(['diff', '--cached', '--name-only'], { cwd })
         .stdout.trim()
         .split('\n')
@@ -329,7 +335,7 @@ function checkGitStatus(workspaces, dirtyMap, cwd, dryRun, autoTick) {
             }
         }
     }
-    return checkForUnpushedCommits(cwd, autoTick);
+    return checkForUnpushedCommits(cwd, autoTick, allowNoUpstream);
 }
 /**
  * Get version info for dirty workspaces
@@ -494,7 +500,7 @@ function buildPackages(releaseOrder, packageInfos) {
         }
     }
 }
-function validatePublish(dryRun, autoTick) {
+function validatePublish(dryRun, autoTick, allowNoUpstream) {
     // Push any previous auto-tick commits if in full mode
     if (!dryRun) {
         const upstreamResult = git(['rev-parse', '--abbrev-ref', '@{u}'], {
@@ -538,7 +544,7 @@ function validatePublish(dryRun, autoTick) {
     console.log('\n🗃️  Validating git status...\n');
     const dirtyMap = getDirtyMap(workspaces, lastTag, cwd);
     // Check git status
-    const gitClean = checkGitStatus(workspaces, dirtyMap, cwd, dryRun, autoTick);
+    const gitClean = checkGitStatus(workspaces, dirtyMap, cwd, dryRun, autoTick, allowNoUpstream);
     if (!gitClean) {
         console.error('❌ Git issues detected. Commit/stash changes before publishing.\n');
         process.exit(1);
@@ -621,7 +627,7 @@ function validatePublish(dryRun, autoTick) {
         console.log('\n🗃️  Re-validating...\n');
         // In dry-run mode, we allow the auto-tick commit to remain unpushed
         if (!dryRun) {
-            if (!checkForUnpushedCommits(cwd, autoTick)) {
+            if (!checkForUnpushedCommits(cwd, autoTick, allowNoUpstream)) {
                 process.exit(1);
             }
         }
@@ -734,7 +740,44 @@ function runNpmPublishInReleaseOrder(releaseOrder, packageInfos, packagesToRelea
         }
     }
 }
+/**
+ * Ensures the current branch has an upstream remote tracking branch.
+ * If no upstream exists, pushes the branch with -u to set it.
+ * This is necessary before pushing tags to ensure the branch is on remote.
+ */
+function ensureBranchHasUpstream() {
+    try {
+        const currentBranch = execSync('git branch --show-current', {
+            encoding: 'utf8',
+        }).trim();
+        // Check if upstream exists (command throws if not)
+        execSync(`git rev-parse --abbrev-ref ${currentBranch}@{u}`, {
+            encoding: 'utf8',
+            stdio: ['pipe', 'pipe', 'pipe'],
+        });
+        // Upstream exists - nothing to do
+    }
+    catch (err) {
+        // No upstream - set it by pushing current branch
+        console.log(`ℹ️  Branch has no upstream, setting it now...`);
+        const currentBranch = execSync('git branch --show-current', {
+            encoding: 'utf8',
+        }).trim();
+        try {
+            execSync(`git push -u origin ${currentBranch}`, {
+                stdio: 'inherit',
+            });
+            console.log(`✅ Upstream set for ${currentBranch}`);
+        }
+        catch (pushErr) {
+            console.error(`❌ Failed to set upstream for ${currentBranch}`);
+            throw pushErr;
+        }
+    }
+}
 function tagAndPushRepo(version, tagSuffix) {
+    // Ensure branch has upstream before pushing tags
+    ensureBranchHasUpstream();
     try {
         execSync(`git tag v${version}${tagSuffix}`, { stdio: 'inherit' });
         execSync(`git push origin v${version}${tagSuffix}`, {
@@ -765,13 +808,15 @@ program
     .option('--registry <url>', 'NPM registry to publish to')
     .option('--auto-tick', 'Automatically tick patch versions if needed')
     .option('--anchor-tag-suffix <suffix>', "A tagging suffix convention which deviates from vx.x.x. E.g. if --anchor-tag-suffix=-rc is provided, tags (when not in dry-run mode) will be created in the form 'vx.x.x-rc'")
+    .option('--allow-no-upstream', 'Allow publishing from branches without upstream tracking. The tool will automatically set upstream when pushing tags. Intended for CI/CD pipelines that create new release branches.')
     .action((options) => {
     printHeader();
     const dryRun = options.dryRun;
     const registryUrl = options.registry;
     const autoTick = options.autoTick;
     const anchorTagSuffix = options.anchorTagSuffix ?? '';
-    const { packageInfos, releaseOrder, packagesToRelease, currentRootVersion, } = validatePublish(dryRun, autoTick);
+    const allowNoUpstream = options.allowNoUpstream ?? false;
+    const { packageInfos, releaseOrder, packagesToRelease, currentRootVersion, } = validatePublish(dryRun, autoTick, allowNoUpstream);
     if (packagesToRelease.length === 0) {
         return console.log('\n￣\\_(ツ)_/￣ No workspaces to publish\n');
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-workspaces-publish-tool",
-    "version": "0.0.15",
+    "version": "0.0.17",
     "description": "An unopinionated tool to assist publishing of npm based mono-repo workspaces",
     "main": "build/src/cli.js",
     "type": "module",