super-release 1.10.0 → 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +85 -0
- package/bin/super-release-darwin-aarch64.tar.gz.sha256 +1 -1
- package/bin/super-release-darwin-x86_64.tar.gz.sha256 +1 -1
- package/bin/super-release-linux-aarch64-musl.tar.gz.sha256 +1 -0
- package/bin/super-release-linux-aarch64.tar.gz.sha256 +1 -1
- package/bin/super-release-linux-x86_64-musl.tar.gz.sha256 +1 -1
- package/bin/super-release-linux-x86_64.tar.gz.sha256 +1 -1
- package/bin/super-release-windows-x86_64.zip.sha256 +1 -1
- package/config-schema.json +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -43,6 +43,91 @@ Alternatively, build from source:
|
|
|
43
43
|
cargo install --path .
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
+
## GitHub Action
|
|
47
|
+
|
|
48
|
+
Run super-release with a single `uses:`. It is a Docker container action published
|
|
49
|
+
to GHCR, so it runs on **Linux runners only**.
|
|
50
|
+
|
|
51
|
+
```yaml
|
|
52
|
+
name: Release
|
|
53
|
+
on:
|
|
54
|
+
push:
|
|
55
|
+
branches: [main]
|
|
56
|
+
|
|
57
|
+
permissions:
|
|
58
|
+
contents: write # create releases and tags
|
|
59
|
+
issues: write # "released" comments/labels (optional)
|
|
60
|
+
pull-requests: write # PR preview / released comments (optional)
|
|
61
|
+
id-token: write # npm provenance (optional)
|
|
62
|
+
|
|
63
|
+
jobs:
|
|
64
|
+
release:
|
|
65
|
+
runs-on: ubuntu-latest
|
|
66
|
+
steps:
|
|
67
|
+
- uses: actions/checkout@v4
|
|
68
|
+
with:
|
|
69
|
+
fetch-depth: 0 # full history + tags are required
|
|
70
|
+
# Only if you publish to npm:
|
|
71
|
+
- uses: actions/setup-node@v4
|
|
72
|
+
with:
|
|
73
|
+
node-version: 22
|
|
74
|
+
registry-url: https://registry.npmjs.org
|
|
75
|
+
- uses: bowlingx/super-release@v1
|
|
76
|
+
env:
|
|
77
|
+
GITHUB_TOKEN: ${{ github.token }}
|
|
78
|
+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} # only if publishing to npm
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
On pull requests, set `preview: true` to post a sticky comment with the next
|
|
82
|
+
version and rendered release notes (needs `pull-requests: write`):
|
|
83
|
+
|
|
84
|
+
```yaml
|
|
85
|
+
- uses: bowlingx/super-release@v1
|
|
86
|
+
with:
|
|
87
|
+
preview: true
|
|
88
|
+
env:
|
|
89
|
+
GITHUB_TOKEN: ${{ github.token }}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Inputs
|
|
93
|
+
|
|
94
|
+
| Input | Default | Description |
|
|
95
|
+
|---------------------------------|-----------------------|--------------------------------------------------------|
|
|
96
|
+
| `github-token` | `${{ github.token }}` | Token for the GitHub API (releases, comments). |
|
|
97
|
+
| `dry-run` | `false` | Show what would happen without making changes. |
|
|
98
|
+
| `preview` | `false` | Post/update a PR preview comment instead of releasing. |
|
|
99
|
+
| `config` | | Path to the config file (default `.release.yaml`). |
|
|
100
|
+
| `package` | | Filter to a specific package. |
|
|
101
|
+
| `working-directory` | | Repository root to operate on. |
|
|
102
|
+
| `dangerously-skip-config-check` | `false` | Skip config-schema validation. |
|
|
103
|
+
| `args` | | Extra raw CLI flags (escape hatch). |
|
|
104
|
+
|
|
105
|
+
**Requirements**
|
|
106
|
+
|
|
107
|
+
- **`fetch-depth: 0`** — version bumps are computed from the full history and all
|
|
108
|
+
tags; a shallow checkout produces wrong versions.
|
|
109
|
+
- **`contents: write`** and a token, to create releases and tags.
|
|
110
|
+
- **npm auth** (only if you publish to npm) is configured out of band, exactly like
|
|
111
|
+
any npm workflow: `actions/setup-node` with `registry-url` plus `NODE_AUTH_TOKEN`,
|
|
112
|
+
or an `.npmrc`.
|
|
113
|
+
|
|
114
|
+
Pin to a major with `@v1`; the action resolves the matching `:v1` image (latest
|
|
115
|
+
1.x). For a fully pinned image, use the [Docker](#docker) usage with a `:X.Y.Z` tag.
|
|
116
|
+
|
|
117
|
+
## Docker
|
|
118
|
+
|
|
119
|
+
The same image is published to GHCR for use from any CI or locally:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
docker run --rm \
|
|
123
|
+
-v "$PWD:/repo" -w /repo \
|
|
124
|
+
-e GITHUB_TOKEN \
|
|
125
|
+
ghcr.io/bowlingx/super-release:v1 --dry-run
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Tags: `:v1` (latest 1.x), `:latest`, `:X.Y.Z` (exact), `:sha-<commit>`. The image is
|
|
129
|
+
Alpine-based and bundles `git` and Node.js (for the `npm` step).
|
|
130
|
+
|
|
46
131
|
## Quick Start
|
|
47
132
|
|
|
48
133
|
```bash
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
d6c859bfdd81b93c9c34f4a6d705976cefb9ae4133db27d62a5fefe9f565e8ff super-release-darwin-aarch64.tar.gz
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
1251b9dea955d44f2890099b39d1e373fcf7cf6b825e1bf4d210aea55c7ebf47 super-release-darwin-x86_64.tar.gz
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
143047181af1027a5c654a31f47ee88e12839f828590e585db4a682f48871058 super-release-linux-aarch64-musl.tar.gz
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
a06b1d19cb24dee8b419474502d4c03095dafeffb3018867b4f8d5b5465875f9 super-release-linux-aarch64.tar.gz
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
d46444206050ffa44d8de21cbe42be0d445529f873b97a0bfb3bcbfee5938a12 super-release-linux-x86_64-musl.tar.gz
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
4fa20735cf8e67e974ed26b9d328166840fb754a693bb27ae1af048e95f736c9 super-release-linux-x86_64.tar.gz
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
7E9D4106FC6D48C30EC8FD79E61174B6A2688B38427D77306801CF33351B33A9
|
package/config-schema.json
CHANGED
|
@@ -308,7 +308,7 @@
|
|
|
308
308
|
},
|
|
309
309
|
"success_comment": {
|
|
310
310
|
"type": "string",
|
|
311
|
-
"description": "Success-comment template. Placeholders: {releases} (the
|
|
311
|
+
"description": "Success-comment template. Placeholders: {releases} (markdown links to the released packages, named via release_name_template), {tag} (the first release's raw git tag)."
|
|
312
312
|
},
|
|
313
313
|
"released_labels": {
|
|
314
314
|
"type": "array",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "super-release",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.12.0",
|
|
4
4
|
"description": "A fast semantic-release alternative for monorepos, written in Rust",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"changelog",
|
|
@@ -28,11 +28,11 @@
|
|
|
28
28
|
"provenance": true
|
|
29
29
|
},
|
|
30
30
|
"optionalDependencies": {
|
|
31
|
-
"super-release-
|
|
32
|
-
"super-release-
|
|
33
|
-
"super-release-
|
|
34
|
-
"super-release-
|
|
35
|
-
"super-release-
|
|
31
|
+
"super-release-darwin-arm64": "1.10.0",
|
|
32
|
+
"super-release-darwin-x64": "1.10.0",
|
|
33
|
+
"super-release-linux-arm64": "1.10.0",
|
|
34
|
+
"super-release-linux-x64": "1.10.0",
|
|
35
|
+
"super-release-windows-x64": "1.10.0"
|
|
36
36
|
},
|
|
37
37
|
"engines": {
|
|
38
38
|
"node": ">=20"
|