@tritard/waterbrother 0.5.0 → 0.5.5
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 +32 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -110,13 +110,15 @@ It is Vercel-ready via `vercel.json` (clean URLs, no build step required).
|
|
|
110
110
|
|
|
111
111
|
## Quick start
|
|
112
112
|
|
|
113
|
-
User install
|
|
113
|
+
User install:
|
|
114
114
|
|
|
115
115
|
```bash
|
|
116
116
|
npm install -g @tritard/waterbrother
|
|
117
117
|
waterbrother
|
|
118
118
|
```
|
|
119
119
|
|
|
120
|
+
Partners and maintainers ship updates through GitHub Actions, not from personal laptops. The package publish workflow runs on version tags and uses the repository `NPM_TOKEN` secret.
|
|
121
|
+
|
|
120
122
|
Source install for contributors:
|
|
121
123
|
|
|
122
124
|
```bash
|
|
@@ -184,6 +186,35 @@ waterbrother "Search the web for the latest xAI API docs about vision support an
|
|
|
184
186
|
/open 1
|
|
185
187
|
```
|
|
186
188
|
|
|
189
|
+
## Release flow
|
|
190
|
+
|
|
191
|
+
Partners should ship updates by pushing a version tag, not by running `npm publish` locally.
|
|
192
|
+
|
|
193
|
+
1. Add an npm publish token as the repository secret `NPM_TOKEN`. The token must be able to publish `@tritard/waterbrother`.
|
|
194
|
+
2. Bump the package version locally:
|
|
195
|
+
|
|
196
|
+
```bash
|
|
197
|
+
npm version patch
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
Use `minor` or `major` when appropriate.
|
|
201
|
+
|
|
202
|
+
3. Push `main` and the new tag:
|
|
203
|
+
|
|
204
|
+
```bash
|
|
205
|
+
git push origin main --tags
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
4. GitHub Actions runs `.github/workflows/publish.yml` and publishes the package after `npm ci`, `npm run check`, and `npm run smoke` pass.
|
|
209
|
+
|
|
210
|
+
5. Users update with:
|
|
211
|
+
|
|
212
|
+
```bash
|
|
213
|
+
npm install -g @tritard/waterbrother@latest
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
This lets partners such as Umair and Austin ship releases without using the publisher's local machine or Touch ID.
|
|
217
|
+
|
|
187
218
|
Long-running session controls:
|
|
188
219
|
|
|
189
220
|
```bash
|