super-release 1.8.0 → 1.9.0

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 @@
-f9f0b931c4cb2bad05442c0826e0aa0863237995a5b33a32517e61d63baed35b  super-release-darwin-aarch64.tar.gz
+cb728b46cf84f0bf9793982e8e1142f04717563a092fd7ce172947395d2031a0  super-release-darwin-aarch64.tar.gz

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

@@ -1 +1 @@
-510f3b7f6d207c4a2e4a21ee89e47d035d532af56eb4a829d82d3792e1c434f7  super-release-darwin-x86_64.tar.gz
+54d282d40d88f3750a7485a5603bc851d209dca9ff2111a398fe9510232de083  super-release-darwin-x86_64.tar.gz

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

@@ -1 +1 @@
-edf924710452f2eae7452a122ae1ea8ae5e092d4a42abb7c8ff224daa8dd127d  super-release-linux-aarch64.tar.gz
+470913d868f609a844cf27a64e35138aa5810e31de89659bffedfb0c0ec9e04c  super-release-linux-aarch64.tar.gz

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

@@ -1 +1 @@
-03411e6dc7879f682309396650254cf517dfa495c54e37c4b982305258c5ebf6  super-release-linux-x86_64-musl.tar.gz
+0726658457d8c9dd6e6a0c634e3801106298b9d137fd08b2dbe349f84ad88aa5  super-release-linux-x86_64-musl.tar.gz

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

@@ -1 +1 @@
-1d97a52c52faa687305cbfe88533e75322c8fa6fc8a3162cd9b639eae1345b88  super-release-linux-x86_64.tar.gz
+196bd7bb20ded3bcd7df6d901f77c16910eb7bca8d5978078fab93ce14e6a930  super-release-linux-x86_64.tar.gz

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

@@ -1 +1 @@
-A309DA7E56E5F0F94BE84129701644C487C01DB13BB01F8B8067C905A0D8FF10
+25D08F5932DEBF5362192FAEFEB5980C06D6DBC358DC8A0B27D56AD9D6446C72

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.0",
+  "version": "1.9.0",
   "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.0",
-    "super-release-linux-arm64": "1.6.0",
-    "super-release-darwin-x64": "1.6.0",
-    "super-release-linux-x64": "1.6.0",
-    "super-release-windows-x64": "1.6.0"
+    "super-release-darwin-arm64": "1.7.0",
+    "super-release-linux-arm64": "1.7.0",
+    "super-release-windows-x64": "1.7.0",
+    "super-release-darwin-x64": "1.7.0",
+    "super-release-linux-x64": "1.7.0"
   },
   "engines": {
     "node": ">=20"