@releasekit/publish 0.3.0 → 0.4.0

package/README.md

@@ -1,6 +1,10 @@
 # @releasekit/publish
 
-Publish packages to npm and crates.io with git tagging and GitHub releases.
+[![@releasekit/publish](https://img.shields.io/badge/@releasekit-publish-9feaf9?labelColor=1a1a1a&style=plastic)](https://www.npmjs.com/package/@releasekit/publish)
+[![Version](https://img.shields.io/npm/v/@releasekit/publish?color=28a745&labelColor=1a1a1a)](https://www.npmjs.com/package/@releasekit/publish)
+[![Downloads](https://img.shields.io/npm/dw/@releasekit/publish?color=6f42c1&labelColor=1a1a1a)](https://www.npmjs.com/package/@releasekit/publish)
+
+**Publish packages to npm and crates.io with git tagging and GitHub releases.**
 
 ## Features
 
@@ -50,6 +54,8 @@ The publish pipeline runs in order:
 8. **Git Push** - Push commits and tags to remote
 9. **GitHub Release** - Create GitHub releases
 
+The pipeline is **fail-fast**: the first package publish failure throws immediately. Git push and GitHub release are skipped, so the version commit and tag remain local until the issue is fixed and the release is retried.
+
 ## CLI Reference
 
 | Flag | Description | Default |
@@ -59,7 +65,7 @@ The publish pipeline runs in order:
 | `--registry <type>` | Registry to publish to: `npm`, `cargo`, `all` | `all` |
 | `--npm-auth <method>` | NPM auth method: `oidc`, `token`, `auto` | `auto` |
 | `--dry-run` | Simulate all operations | `false` |
-| `--skip-git` | Skip git commit/tag/push | `false` |
+| `--skip-git` | Skip git commit/tag/push (also skips GitHub release — no tag to release against) | `false` |
 | `--skip-publish` | Skip registry publishing | `false` |
 | `--skip-github-release` | Skip GitHub Release creation | `false` |
 | `--skip-verification` | Skip post-publish verification | `false` |
@@ -126,7 +132,7 @@ Configure via `releasekit.config.json`:
     "githubRelease": {
       "enabled": true,
       "draft": true,
-      "generateNotes": true
+      "body": "auto"
     },
     "verify": {
       "npm": {
@@ -144,6 +150,11 @@ Configure via `releasekit.config.json`:
 
 See [@releasekit/config](../config/README.md) for full configuration options.
 
+## Documentation
+
+**Guides**
+- [GitHub Releases](./docs/github-releases.md) — release body options, LLM prose, draft workflow
+
 ## License
 
 MIT