super-release 1.11.0 → 1.12.1
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/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
|
+
1a34da741adc8ce8311a44aab32ff1fadcce49f42608338fabfed4e30709481f super-release-darwin-aarch64.tar.gz
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
1453362bfabbda76679f299971ab25df48cfae859e3dc49457aacbe344c1c259 super-release-darwin-x86_64.tar.gz
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
19c1ddb6bee2319f38cb7c4c40be82d88e63e20e70d94bf3d32f94bf7726ebf2 super-release-linux-aarch64-musl.tar.gz
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
db143470bcec6271ec88e5761a9a47753a8ae106d2e0dfd00271092df9f8f5fb super-release-linux-aarch64.tar.gz
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
c54fe02d10ac4f60b278798f35e76649ea522661af4ba55cccf69891e1104eca super-release-linux-x86_64-musl.tar.gz
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
7f22185f9ca489915b8103883991c97ee290ac4daeb19eb03616bf00b6ea7c54 super-release-linux-x86_64.tar.gz
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
55C42C00434E21C3100C0503939AF34AF1521044886B372C6B53C57F910E51A1
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "super-release",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.12.1",
|
|
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-darwin-arm64": "1.
|
|
32
|
-
"super-release-darwin-x64": "1.
|
|
33
|
-
"super-release-linux-
|
|
34
|
-
"super-release-
|
|
35
|
-
"super-release-
|
|
31
|
+
"super-release-darwin-arm64": "1.10.1",
|
|
32
|
+
"super-release-darwin-x64": "1.10.1",
|
|
33
|
+
"super-release-linux-arm64": "1.10.1",
|
|
34
|
+
"super-release-linux-x64": "1.10.1",
|
|
35
|
+
"super-release-windows-x64": "1.10.1"
|
|
36
36
|
},
|
|
37
37
|
"engines": {
|
|
38
38
|
"node": ">=20"
|