super-release 1.8.1 → 1.9.1

package/README.md

@@ -70,6 +70,11 @@ Options:
   -C, --path <PATH>            Repository root [default: .]
   -c, --config <CONFIG>        Path to config file [default: .release.yaml]
       --show-next-version      Print the next version and exit
+      --preview                Render a pull-request release preview and exit
+      --pr <PR>                Pull request number for --preview (auto-detected in CI)
+      --repo <OWNER/NAME>      GitHub repository for --preview (auto-detected)
+      --base <BRANCH>          Base branch to evaluate --preview against
+      --no-comment             With --preview, print Markdown instead of commenting
   -p, --package <PACKAGE>      Filter to a specific package (for --show-next-version)
   -v, --verbose                Verbose output
       --dangerously-skip-config-check
@@ -89,6 +94,26 @@ SUPER_RELEASE_VERSION=$VERSION cargo build --release
 
 In monorepos, use `--package` to select which package: `super-release --show-next-version -p @acme/core`
 
+### `--preview`
+
+Renders a **release preview** for a pull request: the next version for each package plus a preview of the release
+notes, without changing anything. When a GitHub token and a pull request are detected (as in GitHub Actions), it posts —
+and on later runs updates in place — a single "sticky" comment on the PR. Otherwise it prints the Markdown to stdout so
+you can pipe it into your own comment step.
+
+```bash
+# In CI (GitHub Actions): auto-detects the PR, repo, base branch, and token
+super-release --preview
+
+# Locally / other CI: print the Markdown
+super-release --preview --base main --no-comment
+```
+
+The preview evaluates the PR against its **base** branch and reflects the commits currently on the branch, so the final
+release may differ after a squash-merge. Requires `pull-requests: write` permission and a full checkout
+(`fetch-depth: 0`). A ready-to-use workflow lives in
+[`.github/workflows/pr-preview.yml`](.github/workflows/pr-preview.yml).
+
 ## How It Works
 
 1. **Discover packages** -- finds all directories with a `package.json` (respects `.gitignore`)
@@ -336,6 +361,17 @@ steps:
       prepare_cmd: 'sed -i'''' -e ''s/^version = .*/version = "{version}"/'' Cargo.toml'
       publish_cmd: 'cargo publish'
       files: [Cargo.toml, Cargo.lock] # include in git commit
+
+  - name: github
+    options:
+      assets: ['dist/*.tgz'] # glob(s), relative to repo root
+      draft: false
+      # prerelease: true      # default: true on prerelease branches
+      # release_name_template: '{name} v{version}'  # default: the tag
+      # github_url: https://ghe.corp/api/v3         # GitHub Enterprise
+      comment_on_success: true # comment on resolved PRs/issues (default: true)
+      released_labels: ['released'] # labels added to them (default: ['released'])
+      # success_comment: '🎉 Shipped in {releases}'  # {releases} = the tags, {tag}
 ```
 
 Each step can be scoped:
@@ -345,15 +381,27 @@ Each step can be scoped:
 - **`branches`** -- glob patterns for branch names this step runs on. If empty, the step runs on all branches.
   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                  |
+| Step        | Prepare/Publish                                        | Release (after tags are pushed)                          |
+| ----------- | ------------------------------------------------------ | -------------------------------------------------------- |
+| `changelog` | Generates/updates changelog per package (parallel)     | --                                                       |
+| `npm`       | Publishes packages (parallel within dependency levels) | --                                                       |
+| `exec`      | Runs custom shell command per package                  | --                                                       |
+| `github`    | --                                                     | Creates a GitHub Release per package with its notes + assets |
 
 Package version bumps (`package.json`) happen automatically before steps run (part of core).
 Steps return the files they modified. The core git step stages exactly those files for the commit -- no `git add .`.
 
+The `github` step runs **after** the commit and tags are pushed, so it needs `git.push: true` and a
+`GITHUB_TOKEN` (or `GH_TOKEN`) with `contents: write` (and `issues: write` + `pull-requests: write` for
+comments). It creates one GitHub Release per released package (idempotent -- safe to re-run) and comments on the
+PRs/issues each release resolved (detected from `(#N)` squash/merge subjects and `closes/fixes #N` keywords),
+adding a `released` label. Comments are posted once (marker-guarded), so re-runs don't duplicate them.
+
+Release bodies are enriched with GitHub data when a token is available -- a "What's Changed" list with `@author`
+mentions and PR links, plus a "New Contributors" section -- via git-cliff's GitHub integration (the API calls are
+cached on disk, and fall back to the plain git-cliff notes if the fetch fails). The `CHANGELOG.md` file keeps its
+conventional grouped format.
+
 Default: `[changelog, npm]`
 
 #### `git`

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

@@ -1 +1 @@
-5adb8bd8adf5a50f199ccec6430df144388e063857bbd17a1f5943bf68e3b186  super-release-darwin-aarch64.tar.gz
+04e1ab4febfbac6b2c15e97bb0e90221ec9d22e4620980172b242ba44238cce8  super-release-darwin-aarch64.tar.gz

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

@@ -1 +1 @@
-8f81c72a3f721df5802b9370695fe31db8c2be2d53fc089671e7caee8b694c32  super-release-darwin-x86_64.tar.gz
+5fd17f7303c3ae36724afbd4bb5973e34ce6cd68070bcc2e1c76bd07c9b25eab  super-release-darwin-x86_64.tar.gz

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

@@ -1 +1 @@
-4bd2f710f3d7016bea5cd5839cddc1aa185144fce0346b09639624167f3540f3  super-release-linux-aarch64.tar.gz
+722e466268fae8a64c091018a9f78c2f78f516905910cb3bfa8b210a1444fd7c  super-release-linux-aarch64.tar.gz

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

@@ -1 +1 @@
-1c46b9505d606dab35f7a1ec9fa7cd3e51c7715ba284161ff6d77f3c2801c272  super-release-linux-x86_64-musl.tar.gz
+1ca5015f55708b2b3c6e44f8ae94ae5059e1cfd09da38d4cb71dec2318f36da6  super-release-linux-x86_64-musl.tar.gz

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

@@ -1 +1 @@
-500e0655d24d267d7f5c85e6e696291fcb1c9d51266f6e54f0bfdbab363a4573  super-release-linux-x86_64.tar.gz
+a861a37df67de4cb24f535c20646e125cf4ed5f2a145bbe75c281a90b98f48e2  super-release-linux-x86_64.tar.gz

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

@@ -1 +1 @@
-492A1A8BA9253D39F2F04502947606A2F46CD902739CF5910367F035738233A0
+E6D69F40AFCEA5DF2B19D67A33AE24FC6F4FB96F2674F5A3597C91665D83B386

package/config-schema.json

@@ -120,7 +120,7 @@
       "properties": {
         "name": {
           "type": "string",
-          "enum": ["changelog", "npm", "exec"],
+          "enum": ["changelog", "npm", "exec", "github"],
           "description": "Step name"
         },
         "packages": {
@@ -155,6 +155,12 @@
           "then": {
             "properties": { "options": { "$ref": "#/$defs/execOptions" } }
           }
+        },
+        {
+          "if": { "properties": { "name": { "const": "github" } } },
+          "then": {
+            "properties": { "options": { "$ref": "#/$defs/githubOptions" } }
+          }
         }
       ]
     },
@@ -259,6 +265,49 @@
           "examples": [["Cargo.toml", "Cargo.lock"]]
         }
       }
+    },
+    "githubOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "draft": {
+          "type": "boolean",
+          "default": false,
+          "description": "Create the GitHub Release as a draft"
+        },
+        "prerelease": {
+          "type": "boolean",
+          "description": "Force the prerelease flag. Default: true on prerelease branches, false otherwise."
+        },
+        "assets": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Glob patterns (relative to the repo root) for files to attach to the release."
+        },
+        "release_name_template": {
+          "type": "string",
+          "description": "Release name template. Placeholders: {name}, {version}, {tag}. Default: the tag."
+        },
+        "github_url": {
+          "type": "string",
+          "format": "uri",
+          "description": "GitHub Enterprise API base URL, e.g. https://ghe.corp/api/v3"
+        },
+        "comment_on_success": {
+          "type": "boolean",
+          "default": true,
+          "description": "Comment on the PRs/issues a release resolves"
+        },
+        "success_comment": {
+          "type": "string",
+          "description": "Success-comment template. Placeholders: {releases} (the tags), {tag}."
+        },
+        "released_labels": {
+          "type": "array",
+          "items": { "type": "string" },
+          "description": "Labels to add to resolved PRs/issues. Default: [\"released\"]."
+        }
+      }
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "super-release",
-  "version": "1.8.1",
+  "version": "1.9.1",
   "description": "A fast semantic-release alternative for monorepos, written in Rust",
   "keywords": [
     "changelog",
@@ -28,11 +28,11 @@
     "provenance": true
   },
   "optionalDependencies": {
-    "super-release-darwin-arm64": "1.6.1",
-    "super-release-linux-arm64": "1.6.1",
-    "super-release-windows-x64": "1.6.1",
-    "super-release-linux-x64": "1.6.1",
-    "super-release-darwin-x64": "1.6.1"
+    "super-release-darwin-arm64": "1.7.1",
+    "super-release-darwin-x64": "1.7.1",
+    "super-release-linux-arm64": "1.7.1",
+    "super-release-linux-x64": "1.7.1",
+    "super-release-windows-x64": "1.7.1"
   },
   "engines": {
     "node": ">=20"