super-release 1.5.2 → 1.6.1

package/README.md

@@ -103,7 +103,7 @@ In monorepos, use `--package` to select which package: `super-release --show-nex
 ## Conventional Commits
 
 | Commit                                                | Bump       |
-|-------------------------------------------------------|------------|
+| ----------------------------------------------------- | ---------- |
 | `fix: ...`                                            | patch      |
 | `feat: ...`                                           | minor      |
 | `feat!: ...` or `BREAKING CHANGE:` in footer          | major      |
@@ -121,38 +121,40 @@ to bypass validation.
 For editor autocompletion:
 
 ```yaml
-# yaml-language-server: $schema=https://raw.githubusercontent.com/bowlingx/super-release/main/schema.json
+# yaml-language-server: $schema=https://raw.githubusercontent.com/bowlingx/super-release/v1.4.0/schema.json
 ```
 
 ```jsonc
 // .release.jsonc
 {
-  "$schema": "https://raw.githubusercontent.com/bowlingx/super-release/main/schema.json"
+  "$schema": "https://raw.githubusercontent.com/bowlingx/super-release/v1.4.0/schema.json",
 }
 ```
 
+Or, if you installed it locally directly via `./node_modules/super-release/config-schema.json`
+
 ### Full Example
 
 ```yaml
 branches:
   - main
   - name: next
-    channel: next                  # publishes to "next" npm dist-tag
+    channel: next # publishes to "next" npm dist-tag
   - name: next-major
     channel: next-major
   - name: beta
     prerelease: beta
-  - name: "test-*"
+  - name: 'test-*'
     prerelease: true
-    packages: [ "@acme/core" ]    # only release core on test branches
-  - name: "1.x"
+    packages: ['@acme/core'] # only release core on test branches
+  - name: '1.x'
     maintenance: true
 
-tag_format: "v{version}"
-tag_format_package: "{name}/v{version}"
+tag_format: 'v{version}'
+tag_format_package: '{name}/v{version}'
 
 packages:
-  - "@acme/*"
+  - '@acme/*'
 
 exclude:
   - my-monorepo-root
@@ -164,9 +166,9 @@ dependencies:
 
 # Files to ignore -- commits touching only these won't trigger releases
 ignore:
-  - "README.md"
-  - "docs/**"
-  - "**/*.md"
+  - 'README.md'
+  - 'docs/**'
+  - '**/*.md'
 
 steps:
   - name: changelog
@@ -175,13 +177,13 @@ steps:
       provenance: true
   - name: exec
     options:
-      prepare_cmd: "sed -i'' -e 's/^version = .*/version = \"{version}\"/' Cargo.toml"
+      prepare_cmd: 'sed -i'''' -e ''s/^version = .*/version = "{version}"/'' Cargo.toml'
       files:
         - Cargo.toml
         - Cargo.lock
 
 git:
-  commit_message: "chore(release): {releases} [skip ci]"
+  commit_message: 'chore(release): {releases} [skip ci]'
   push: false
   remote: origin
 ```
@@ -194,7 +196,7 @@ Defines which branches can produce releases. Only configured branches are allowe
 exits cleanly.
 
 | Form                                            | Type                                | Example versions                 |
-|-------------------------------------------------|-------------------------------------|----------------------------------|
+| ----------------------------------------------- | ----------------------------------- | -------------------------------- |
 | `- main`                                        | Stable (primary)                    | `1.0.0`, `1.1.0`, `2.0.0`        |
 | `- name: next`<br>`  channel: next`             | Stable (next channel)               | `1.1.0` on `next` dist-tag       |
 | `- name: next-major`<br>`  channel: next-major` | Stable (next-major channel)         | `2.0.0` on `next-major` dist-tag |
@@ -210,11 +212,11 @@ non-primary branch should set a `channel` so it publishes to a different npm dis
 
 ```yaml
 branches:
-  - main                          # primary: publishes to "latest"
+  - main # primary: publishes to "latest"
   - name: next
-    channel: next                 # publishes to "next" dist-tag
+    channel: next # publishes to "next" dist-tag
   - name: next-major
-    channel: next-major           # publishes to "next-major" dist-tag
+    channel: next-major # publishes to "next-major" dist-tag
 ```
 
 **Version collision detection**: If a branch tries to release a version that already exists as a tag (e.g. `next`
@@ -234,7 +236,7 @@ If the branch name doesn't follow the `N.x` / `N.N.x` pattern, set `range` expli
 branches:
   - name: legacy-support
     maintenance: true
-    range: "1.5.x"          # cap to 1.5.x patch range
+    range: '1.5.x' # cap to 1.5.x patch range
 ```
 
 In monorepos, packages whose version is outside the maintenance range are automatically skipped. For example, on branch
@@ -246,11 +248,11 @@ Branches can filter which packages they release with `packages`:
 
 ```yaml
 branches:
-  - name: "test-*"
+  - name: 'test-*'
     prerelease: true
     packages: # only release these on test branches
-      - "@acme/core"
-      - "@acme/utils"
+      - '@acme/core'
+      - '@acme/utils'
 ```
 
 **Tag filtering by branch**: Stable branches only see stable tags. Prerelease branches see their own channel's tags plus
@@ -277,7 +279,7 @@ dependencies:
   - yarn.lock
   - pnpm-lock.yaml
   - package.json
-  - ".github/**"
+  - '.github/**'
 ```
 
 #### `ignore`
@@ -287,10 +289,10 @@ both ignored and non-ignored files, only the non-ignored files determine which p
 
 ```yaml
 ignore:
-  - "README.md"
-  - "docs/**"
-  - "**/*.md"
-  - ".prettierrc"
+  - 'README.md'
+  - 'docs/**'
+  - '**/*.md'
+  - '.prettierrc'
 ```
 
 #### `packages` / `exclude`
@@ -299,7 +301,7 @@ Filter which packages are released. `packages` is an allow-list (glob patterns),
 
 ```yaml
 packages:
-  - "@acme/*"
+  - '@acme/*'
 exclude:
   - my-monorepo-root
 ```
@@ -317,23 +319,23 @@ steps:
       preview_lines: 20
 
   - name: npm
-    packages: [ "@acme/*" ]       # only publish @acme packages
-    branches: [ "main", "beta" ]  # only run on main and beta branches
+    packages: ['@acme/*'] # only publish @acme packages
+    branches: ['main', 'beta'] # only run on main and beta branches
     options:
       access: public
       provenance: true
       registry: https://registry.npmjs.org
-      tag: next                 # dist-tag (default: auto from prerelease channel)
-      publish_args: [ "--otp=123456" ]
-      package_manager: yarn     # force specific PM (default: auto-detect)
-      check_registry: true      # check if version exists before publishing (default: true)
+      tag: next # dist-tag (default: auto from prerelease channel)
+      publish_args: ['--otp=123456']
+      package_manager: yarn # force specific PM (default: auto-detect)
+      check_registry: true # check if version exists before publishing (default: true)
 
   - name: exec
-    packages: [ "my-rust-lib" ]
+    packages: ['my-rust-lib']
     options:
-      prepare_cmd: "sed -i'' -e 's/^version = .*/version = \"{version}\"/' Cargo.toml"
-      publish_cmd: "cargo publish"
-      files: [ Cargo.toml, Cargo.lock ]   # include in git commit
+      prepare_cmd: 'sed -i'''' -e ''s/^version = .*/version = "{version}"/'' Cargo.toml'
+      publish_cmd: 'cargo publish'
+      files: [Cargo.toml, Cargo.lock] # include in git commit
 ```
 
 Each step can be scoped:
@@ -344,7 +346,7 @@ Each step can be scoped:
   For example, `branches: ["main"]` ensures a step only runs on the main branch.
 
 | Step        | Prepare                                            | Publish                                                |
-|-------------|----------------------------------------------------|--------------------------------------------------------|
+| ----------- | -------------------------------------------------- | ------------------------------------------------------ |
 | `changelog` | Generates/updates changelog per package (parallel) | --                                                     |
 | `npm`       | --                                                 | Publishes packages (parallel within dependency levels) |
 | `exec`      | Runs custom shell command per package              | Runs custom shell command per package                  |
@@ -360,8 +362,8 @@ Core git behavior after all steps run. Not a step -- always runs.
 
 ```yaml
 git:
-  commit_message: "chore(release): {releases} [skip ci]"
-  push: false          # push commit + tags to remote
+  commit_message: 'chore(release): {releases} [skip ci]'
+  push: false # push commit + tags to remote
   remote: origin
 ```
 
@@ -413,7 +415,7 @@ Use `packages` (allow-list) and `exclude` (deny-list) at the top level to contro
 
 ```yaml
 packages:
-  - "@acme/*"        # only release @acme-scoped packages
+  - '@acme/*' # only release @acme-scoped packages
 exclude:
   - my-monorepo-root # skip the root package
 ```
@@ -445,10 +447,10 @@ You can also use per-branch `packages` filters for explicit control:
 
 ```yaml
 branches:
-  - name: "1.x"
+  - name: '1.x'
     maintenance: true
     packages:
-      - "@acme/utils"    # only release utils on this maintenance branch
+      - '@acme/utils' # only release utils on this maintenance branch
 ```
 
 ## Performance

package/bin/super-release-darwin-aarch64.tar.gz.sha256

@@ -1 +1 @@
-fe6fea5666588e92b2914f5acf8bc65b24ccf406299a81a96519165a45260d98  super-release-darwin-aarch64.tar.gz
+242480267110c1c629f7ea7c0e5afb5f3d276cd3efd62e82113bd97abbbc93f5  super-release-darwin-aarch64.tar.gz

package/bin/super-release-darwin-x86_64.tar.gz.sha256

@@ -1 +1 @@
-4297daede1e4c7cbd52275ee271de053dff63765de4034dbd33838a93d2550a1  super-release-darwin-x86_64.tar.gz
+2554c2c39538522c7cef889222a913218ed2200b4224e7d5844827d7252575ab  super-release-darwin-x86_64.tar.gz

package/bin/super-release-linux-aarch64.tar.gz.sha256

@@ -1 +1 @@
-924669f5db88d8b2dd3ca566cc6510b6c8748d3b0c2920c7405861a8e1ccd47c  super-release-linux-aarch64.tar.gz
+f4db8a76a97105c97e6518a301eeb41157925a03c17791eac97f2a299cb9f765  super-release-linux-aarch64.tar.gz

package/bin/super-release-linux-x86_64-musl.tar.gz.sha256

@@ -1 +1 @@
-a2d0c6fea728465a2d566e8259a3fbd9cf7b82f2310c3365c88a80da0e64f00e  super-release-linux-x86_64-musl.tar.gz
+70875b20523d5653becb8a3fae79af24c77c44b8cc8a07f1324b2a6c4f11e9f2  super-release-linux-x86_64-musl.tar.gz

package/bin/super-release-linux-x86_64.tar.gz.sha256

@@ -1 +1 @@
-6c72879cf4cdf7d55d62694a243043b8b6fd5e09bf23dd6eb4d82f315a4d3819  super-release-linux-x86_64.tar.gz
+50158b54b3833aa99cd0fc652d3e3b543f8d995a35f56be4b600aeb7623e7dae  super-release-linux-x86_64.tar.gz

package/bin/super-release-windows-x86_64.zip.sha256

@@ -1 +1 @@
-C385AA8C6D60D6D47207A27960B2884C600F7E0A55D7BAD32BFB972293D9F229
+895C1A18BFC50973F32A909AAC9FCEEC12BFC2D479BF50D6379EBFD0B30512C8

package/bin/super-release.js

@@ -1,48 +1,52 @@
 #!/usr/bin/env node
 
-import { spawnSync, execFileSync } from "node:child_process";
-import { existsSync } from "node:fs";
-import { arch, platform } from "node:os";
-import { fileURLToPath } from "node:url";
-import pkg from "../package.json" with { type: "json" };
+import { spawnSync, execFileSync } from 'node:child_process'
+import { existsSync } from 'node:fs'
+import { arch, platform } from 'node:os'
+import { fileURLToPath } from 'node:url'
+import pkg from '../package.json' with { type: 'json' }
 
 function isMusl() {
   try {
-    const result = execFileSync("ldd", ["--version"], {
-      stdio: ["pipe", "pipe", "pipe"],
-    });
-    return result.toString().includes("musl");
+    const result = execFileSync('ldd', ['--version'], {
+      stdio: ['pipe', 'pipe', 'pipe'],
+    })
+    return result.toString().includes('musl')
   } catch (err) {
-    if (err.stderr && err.stderr.toString().includes("musl")) {
-      return true;
+    if (err.stderr && err.stderr.toString().includes('musl')) {
+      return true
     }
     return (
-      existsSync("/lib/ld-musl-x86_64.so.1") ||
-      existsSync("/lib/ld-musl-aarch64.so.1")
-    );
+      existsSync('/lib/ld-musl-x86_64.so.1') ||
+      existsSync('/lib/ld-musl-aarch64.so.1')
+    )
   }
 }
 
 function getBinaryPath() {
-  const os = platform() === "win32" ? "windows" : platform();
-  const cpu = arch();
-  const pkgName = `super-release-${os}-${cpu}`;
+  const os = platform() === 'win32' ? 'windows' : platform()
+  const cpu = arch()
+  const pkgName = `super-release-${os}-${cpu}`
 
   try {
-    if (os === "linux" && isMusl()) {
-      return fileURLToPath(import.meta.resolve(`${pkgName}/musl`));
+    if (os === 'linux' && isMusl()) {
+      return fileURLToPath(import.meta.resolve(`${pkgName}/musl`))
     }
-    return fileURLToPath(import.meta.resolve(pkgName));
+    return fileURLToPath(import.meta.resolve(pkgName))
   } catch {
     throw new Error(
-      `Unsupported platform: ${os}-${cpu}. Install the platform-specific package "${pkgName}" manually.`
-    );
+      `Unsupported platform: ${os}-${cpu}. Install the platform-specific package "${pkgName}" manually.`,
+    )
   }
 }
 
 const result = spawnSync(getBinaryPath(), process.argv.slice(2), {
-  stdio: "inherit",
+  stdio: 'inherit',
   env: { ...process.env, SUPER_RELEASE_VERSION: pkg.version },
-});
+})
 
-process.exit(result.status ?? 1);
+if (result.error) {
+  console.error(result.error)
+}
+
+process.exit(result.status ?? 1)

package/config-schema.json

@@ -0,0 +1,259 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/bowlingx/super-release/main/schema.json",
+  "title": "super-release configuration",
+  "description": "Configuration file for super-release (.release.yaml)",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "branches": {
+      "description": "Branch configurations for release channels",
+      "type": ["array", "null"],
+      "default": ["main", "master"],
+      "items": {
+        "oneOf": [
+          {
+            "type": "string",
+            "description": "Simple branch name (stable releases)"
+          },
+          {
+            "$ref": "#/$defs/branchConfig"
+          }
+        ]
+      }
+    },
+    "tag_format": {
+      "description": "Tag format template for root packages. Placeholders: {version}, {name}",
+      "type": "string",
+      "default": "v{version}",
+      "examples": ["v{version}", "{name}-v{version}", "release-{version}"]
+    },
+    "tag_format_package": {
+      "description": "Tag format template for sub-packages in monorepos. Placeholders: {version}, {name}",
+      "type": "string",
+      "default": "{name}/v{version}",
+      "examples": ["{name}/v{version}", "{name}@{version}"]
+    },
+    "packages": {
+      "description": "Glob patterns to include. Only matching packages are released. Default: all",
+      "type": ["array", "null"],
+      "items": { "type": "string" },
+      "examples": [["@acme/*"], ["@acme/core", "@acme/utils"]]
+    },
+    "exclude": {
+      "description": "Glob patterns to exclude from releasing",
+      "type": ["array", "null"],
+      "default": [],
+      "items": { "type": "string" },
+      "examples": [["my-monorepo-root", "@acme/internal-*"]]
+    },
+    "ignore": {
+      "description": "Glob patterns for files to ignore. Commits that only touch ignored files will not trigger a release.",
+      "type": ["array", "null"],
+      "default": [],
+      "items": { "type": "string" },
+      "examples": [["README.md", "docs/**", ".prettierrc", "**/*.md"]]
+    },
+    "dependencies": {
+      "description": "Global file dependency patterns. When a commit changes any matching file, ALL packages are considered affected. Useful for lock files, shared configs, etc.",
+      "type": ["array", "null"],
+      "default": [],
+      "items": { "type": "string" },
+      "examples": [
+        ["yarn.lock", "pnpm-lock.yaml", "package.json", ".github/**"]
+      ]
+    },
+    "steps": {
+      "description": "Ordered list of steps to execute",
+      "type": ["array", "null"],
+      "default": [{ "name": "changelog" }, { "name": "npm" }],
+      "items": {
+        "$ref": "#/$defs/stepConfig"
+      }
+    },
+    "git": {
+      "description": "Git commit and tag behavior after steps run",
+      "$ref": "#/$defs/gitConfig"
+    }
+  },
+  "$defs": {
+    "branchConfig": {
+      "type": "object",
+      "required": ["name"],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Branch name or glob pattern (e.g. \"main\", \"beta\", \"test-*\", \"1.x\")"
+        },
+        "prerelease": {
+          "description": "Prerelease channel. true = use branch name as channel, string = fixed channel name, false/absent = stable",
+          "oneOf": [{ "type": "boolean" }, { "type": "string" }],
+          "examples": [true, "beta", "next", "rc"]
+        },
+        "maintenance": {
+          "type": "boolean",
+          "default": false,
+          "description": "Maintenance branch. Version bumps are capped to the range inferred from the branch name (e.g. 1.x allows minor, 1.5.x allows only patch)"
+        },
+        "range": {
+          "type": "string",
+          "description": "Explicit version range for maintenance branches (e.g. \"1.x\", \"1.5.x\"). If omitted, inferred from branch name.",
+          "examples": ["1.x", "1.5.x", "2.x"]
+        },
+        "channel": {
+          "type": "string",
+          "description": "Distribution channel (npm dist-tag). Defaults to prerelease name for prerelease branches, branch name for maintenance branches, unset (latest) for the primary release branch.",
+          "examples": ["next", "next-major", "1.x"]
+        },
+        "packages": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Glob patterns to include. Only matching packages are released on this branch. Empty = all."
+        }
+      }
+    },
+    "stepConfig": {
+      "type": "object",
+      "required": ["name"],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "enum": ["changelog", "npm", "exec"],
+          "description": "Step name"
+        },
+        "packages": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Glob patterns to filter which packages this step operates on. Empty = all."
+        },
+        "branches": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Glob patterns for branch names this step runs on. Empty = all branches."
+        },
+        "options": {
+          "description": "Step-specific options"
+        }
+      },
+      "allOf": [
+        {
+          "if": { "properties": { "name": { "const": "changelog" } } },
+          "then": {
+            "properties": { "options": { "$ref": "#/$defs/changelogOptions" } }
+          }
+        },
+        {
+          "if": { "properties": { "name": { "const": "npm" } } },
+          "then": {
+            "properties": { "options": { "$ref": "#/$defs/npmOptions" } }
+          }
+        },
+        {
+          "if": { "properties": { "name": { "const": "exec" } } },
+          "then": {
+            "properties": { "options": { "$ref": "#/$defs/execOptions" } }
+          }
+        }
+      ]
+    },
+    "gitConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "commit_message": {
+          "type": "string",
+          "default": "chore(release): {releases} [skip ci]",
+          "description": "Commit message template. Placeholders: {releases}, {summary}, {count}"
+        },
+        "push": {
+          "type": "boolean",
+          "default": false,
+          "description": "Push commit and tags to remote after release"
+        },
+        "remote": {
+          "type": "string",
+          "default": "origin",
+          "description": "Git remote name"
+        }
+      }
+    },
+    "changelogOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "filename": {
+          "type": "string",
+          "default": "CHANGELOG.md",
+          "description": "Output filename per package"
+        },
+        "preview_lines": {
+          "type": "integer",
+          "default": 20,
+          "description": "Max lines shown in dry-run preview"
+        }
+      }
+    },
+    "npmOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "access": {
+          "type": "string",
+          "enum": ["public", "restricted"],
+          "description": "npm access level. If unset, npm's default applies (restricted for scoped, public for unscoped)."
+        },
+        "registry": {
+          "type": "string",
+          "description": "Custom registry URL",
+          "format": "uri"
+        },
+        "tag": {
+          "type": "string",
+          "description": "Dist-tag override. Default: auto from prerelease channel"
+        },
+        "provenance": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable npm provenance (--provenance). Requires npm 9.5+ and supported CI"
+        },
+        "publish_args": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Extra args passed to the publish command"
+        },
+        "check_registry": {
+          "type": "boolean",
+          "default": true,
+          "description": "Check the registry before publishing to skip already-published versions. Set to false to always attempt publish."
+        },
+        "package_manager": {
+          "type": "string",
+          "enum": ["npm", "yarn", "pnpm"],
+          "description": "Force specific package manager (default: auto-detect)"
+        }
+      }
+    },
+    "execOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "prepare_cmd": {
+          "type": "string",
+          "description": "Shell command for prepare phase. Placeholders: {version}, {name}, {channel}"
+        },
+        "publish_cmd": {
+          "type": "string",
+          "description": "Shell command for publish phase. Placeholders: {version}, {name}, {channel}"
+        },
+        "files": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Files to include in the git commit. Supports {version} and {name} placeholders.",
+          "examples": [["Cargo.toml", "Cargo.lock"]]
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,43 +1,44 @@
 {
   "name": "super-release",
-  "type": "module",
-  "version": "1.5.2",
+  "version": "1.6.1",
+  "description": "A fast semantic-release alternative for monorepos, written in Rust",
+  "keywords": [
+    "changelog",
+    "conventional-commits",
+    "monorepo",
+    "release",
+    "semantic-release"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BowlingX/super-release.git"
+  },
   "bin": {
     "super-release": "bin/super-release.js"
   },
-  "description": "A fast semantic-release alternative for monorepos, written in Rust",
-  "engines": {
-    "node": ">=20"
-  },
   "files": [
     "bin",
+    "config-schema.json",
     "README.md"
   ],
-  "keywords": [
-    "semantic-release",
-    "monorepo",
-    "release",
-    "changelog",
-    "conventional-commits"
-  ],
-  "license": "MIT",
+  "type": "module",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/BowlingX/super-release.git"
-  },
   "optionalDependencies": {
-    "super-release-linux-x64": "1.3.1",
-    "super-release-linux-arm64": "1.3.1",
-    "super-release-darwin-x64": "1.3.1",
-    "super-release-darwin-arm64": "1.3.1",
-    "super-release-windows-x64": "1.3.0"
+    "super-release-darwin-arm64": "1.4.1",
+    "super-release-darwin-x64": "1.4.1",
+    "super-release-linux-x64": "1.4.1",
+    "super-release-windows-x64": "1.4.1",
+    "super-release-linux-arm64": "1.4.1"
+  },
+  "engines": {
+    "node": ">=20"
   },
   "scripts": {
-    "prepublish": "cp ../../README.md README.md",
+    "prepublish": "cp ../../README.md README.md && cp ../../schema.json config-schema.json",
     "super-release": "node bin/super-release.js"
   }
 }