@bensandee/tooling 0.54.1 → 0.55.0

package/README.md

@@ -124,6 +124,44 @@ tooling release:simple --release-as major --prerelease beta  # → 2.0.0-beta.0
 
 The generated release workflow exposes these as optional `workflow_dispatch` inputs (`bump` and `prerelease`), so bumps can also be controlled from the CI UI.
 
+#### Release assets
+
+Upload arbitrary build artifacts (tarballs, binaries, zips, etc.) to each release.
+
+**Convention (zero config):** Add a `build:release-assets` script to any `package.json` and have it write artifacts into a `release-assets/` directory alongside the script:
+
+```json
+{
+  "scripts": {
+    "build:release-assets": "mkdir -p release-assets && tar -czf release-assets/app.tar.gz dist"
+  }
+}
+```
+
+On `repo:sync`, `release-assets/` is added to `.gitignore` and a notice is printed confirming the convention was detected. In CI, the generated release workflow runs `tooling release:assets`, which builds every detected package and uploads every file in each `release-assets/` directory to the current tag's release. The script runs from the package directory, so monorepo packages can each emit their own set of artifacts.
+
+If the script runs but writes no files to `release-assets/`, `release:assets` fails with an actionable error rather than silently skipping the upload.
+
+**Override (non-conventional layouts):** For artifacts that don't fit the convention, declare them explicitly in `.tooling.json`:
+
+```json
+{
+  "releaseAssets": [
+    { "file": "dist/app.tar.gz", "command": ["pnpm", "build"], "name": "app.tar.gz" }
+  ]
+}
+```
+
+| Field     | Description                                                                              |
+| --------- | ---------------------------------------------------------------------------------------- |
+| `file`    | Path to the artifact, relative to the project root (required).                           |
+| `command` | argv run before upload (optional; omit for pre-built files). Not interpreted by a shell. |
+| `name`    | Asset name in the release (optional; defaults to the file's basename).                   |
+
+Convention and overrides coexist — a repo can use both.
+
+Works for both `changesets` and `simple` release strategies, on Forgejo (via API upload) and GitHub (via `gh release upload --clobber`). The asset step in the workflow is gated on the release itself having published/pushed, so failed releases never upload stale artifacts.
+
 ### Docker
 
 | Command                  | Description                                                         |