semantic-release-next-version 0.1.3 → 0.1.5

package/README.md

@@ -88,15 +88,11 @@ jobs:
         run: |
           set -euo pipefail
           MODE=""
-          if [ "${{ github.ref }}" = "refs/heads/main" ]; then MODE="--release"; fi
+          if [ "${{ github.ref }}" = "refs/heads/main" ]; then MODE="--release --on-no-release preview"; fi
           VERSION=$(npx next-version-helper $MODE)
-          if [ -z "$VERSION" ]; then
-            echo "semantic-release did not return a next version." >&2
-            exit 1
-          fi
           echo "version=$VERSION" >> "$GITHUB_OUTPUT"
-        env:
-          DEBUG: semantic-release-next-version,semantic-release:* # to enable debugging
+        # env:
+        #   DEBUG: semantic-release-next-version,semantic-release:* # enable for debugging
 ```
 
 Now other jobs can use the version:
@@ -119,6 +115,9 @@ npx next-version-helper
 npx next-version-helper --release
 # → 0.4.0
 
+npx next-version-helper --release --on-no-release preview
+# → 0.4.0-preview-abc1234 (when no releasable commits)
+
 # When you run from outside the repo (e.g. a packed tarball):
 npx next-version-helper --cwd /path/to/your/checkout --release
 ```
@@ -131,7 +130,7 @@ import { getNextVersion } from 'semantic-release-next-version'
 const version = await getNextVersion({
   cwd: process.cwd(),
   release: false,
-  mainBranch: 'main', // override if your primary branch differs
+  defaultBranch: 'main', // override if your primary branch differs
 })
 console.log(version)
 ```
@@ -141,8 +140,13 @@ console.log(version)
 ## CLI options
 
 - `--release` / `-r`: return plain `x.y.z` (no preview suffix).
+- `--on-no-release <mode>`: behavior when `--release` has no releasable commits:
+  - `error` (default): exit with an error.
+  - `current`: return `<currentVersion>`.
+  - `preview`: return `<currentVersion>-preview-<hash>`.
 - `--cwd <path>`: run against a different working directory (useful when you call from a temp folder).
-- `--main-branch <name>`: set the primary release branch (default: `main`).
+- `--default-branch <name>`: set the primary release branch (default: `main`).
+- `--main-branch <name>`: deprecated alias for `--default-branch`.
 - `--help` / `--version`
 
 ---
@@ -151,10 +155,16 @@ console.log(version)
 
 - On `main` branch with `--release` → returns `x.y.z`.
 - On any branch without `--release` → returns `x.y.z-preview-<hash>`.
-- If there is no new release → exits with an error
+- If there is no new release in preview mode → returns `<currentVersion>-preview-<hash>`.
+- If there is no new release with `--release`:
+  - `--on-no-release error` (default) → exits with an error.
+  - `--on-no-release current` → returns `<currentVersion>`.
+  - `--on-no-release preview` → returns `<currentVersion>-preview-<hash>`.
+- `currentVersion` is resolved from the latest semantic version tag, then falls back to `package.json` version.
 - Uses `@semantic-release/commit-analyzer` by default (must be installed).
-- Main branch defaults to `main`; override with `--main-branch` or `mainBranch` in code.
+- Default branch defaults to `main`; override with `--default-branch` or `defaultBranch` in code.
 - `--cwd` lets you run the CLI outside the repo root (for example after `npm pack`).
+- Recommended for main-branch packaging/smoke flows: `--release --on-no-release preview` to keep artifacts clearly non-stable and reduce accidental publish risk.
 
 ---
 
@@ -177,4 +187,4 @@ MIT
 
 - Enable verbose logs by setting `DEBUG=semantic-release-next-version` (optionally add `,semantic-release:*` for semantic-release internals).
 - In GitHub Actions, you can set `DEBUG` in a step that runs the CLI (the CI smoke test does this).
-- When running from a packed tarball or temp dir, pass `--cwd /path/to/repo` and `--main-branch <branch>` so branch detection stays correct.
+- When running from a packed tarball or temp dir, pass `--cwd /path/to/repo` and `--default-branch <branch>` so branch detection stays correct.