just-ship-it 0.0.1 → 0.0.3

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.
Files changed (2) hide show
  1. package/README.md +18 -5
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -53,12 +53,15 @@ bun test
53
53
  - Or visit [bun.sh](https://bun.sh) for other installation methods
54
54
  - Note: End users do NOT need bun installed to use just-ship-it
55
55
  - **GitHub CLI**: Must be installed and authenticated
56
+
56
57
  ```bash
57
58
  gh auth login
58
59
  ```
60
+
59
61
  - **OpenRouter API Key**: Required for AI features
60
62
  - Sign up at [openrouter.ai](https://openrouter.ai)
61
63
  - Set your API key as an environment variable:
64
+
62
65
  ```bash
63
66
  export OPENROUTER_API_KEY='your_api_key_here'
64
67
  ```
@@ -102,6 +105,7 @@ just-ship-it add my-project
102
105
  ```
103
106
 
104
107
  Follow the prompts to configure:
108
+
105
109
  - GitHub owner (organization or user)
106
110
  - Repository name
107
111
  - Base branch (typically `main`)
@@ -118,6 +122,7 @@ just-ship-it
118
122
  ```
119
123
 
120
124
  The CLI will:
125
+
121
126
  1. Show you a list of configured repositories
122
127
  2. Analyze your changes since the last release
123
128
  3. Suggest a version bump type (patch/minor/major)
@@ -149,12 +154,14 @@ just-ship-it my-project --model openai/gpt-4o
149
154
  Run a release for the specified repository (or select interactively).
150
155
 
151
156
  **Options:**
157
+
152
158
  - `-t, --type <type>`: Release type (`patch`, `minor`, or `major`)
153
159
  - `-m, --message <message>`: Release message (overrides AI generation)
154
160
  - `-y, --yes`: Skip confirmation prompts
155
161
  - `--model <model>`: AI model to use for this release
156
162
 
157
163
  **Example:**
164
+
158
165
  ```bash
159
166
  just-ship-it my-app --type patch --yes
160
167
  ```
@@ -164,12 +171,14 @@ just-ship-it my-app --type patch --yes
164
171
  Add a new repository configuration.
165
172
 
166
173
  **Options:**
174
+
167
175
  - `--model <model>`: Default model for this repository
168
176
  - `--monorepo`: Configure as monorepo (will prompt for versioning mode)
169
177
  - `--lockstep`: Use lockstep versioning (all packages bump together)
170
178
  - `--selective`: Use selective versioning (only changed packages bump)
171
179
 
172
180
  **Examples:**
181
+
173
182
  ```bash
174
183
  # Single package repository
175
184
  just-ship-it add my-project --model anthropic/claude-opus-4.5
@@ -189,6 +198,7 @@ just-ship-it add platform --selective
189
198
  List all configured repositories.
190
199
 
191
200
  **Example:**
201
+
192
202
  ```bash
193
203
  just-ship-it list
194
204
  ```
@@ -261,6 +271,7 @@ just-ship-it add my-monorepo --selective
261
271
  ```
262
272
 
263
273
  **How it works:**
274
+
264
275
  1. Detects which packages have changes since the last release
265
276
  2. AI analyzes each changed package independently
266
277
  3. You can choose to skip or bump each package individually
@@ -275,6 +286,7 @@ just-ship-it add design-system --lockstep
275
286
  ```
276
287
 
277
288
  **How it works:**
289
+
278
290
  1. All packages in the workspace are included
279
291
  2. AI suggests a single version bump based on all changes
280
292
  3. All packages receive the same version bump
@@ -292,6 +304,7 @@ For monorepos, just-ship-it analyzes each package's changes independently:
292
304
  ### Example Workflows
293
305
 
294
306
  **Selective Release:**
307
+
295
308
  ```bash
296
309
  # Setup
297
310
  just-ship-it add platform --selective
@@ -307,6 +320,7 @@ just-ship-it platform
307
320
  ```
308
321
 
309
322
  **Lockstep Release:**
323
+
310
324
  ```bash
311
325
  # Setup
312
326
  just-ship-it add ui-library --lockstep
@@ -326,6 +340,7 @@ just-ship-it ui-library
326
340
  Configuration is stored in `~/.just-ship-it/config.json`:
327
341
 
328
342
  **Single Package:**
343
+
329
344
  ```json
330
345
  {
331
346
  "repos": {
@@ -341,6 +356,7 @@ Configuration is stored in `~/.just-ship-it/config.json`:
341
356
  ```
342
357
 
343
358
  **Monorepo (Selective):**
359
+
344
360
  ```json
345
361
  {
346
362
  "repos": {
@@ -359,6 +375,7 @@ Configuration is stored in `~/.just-ship-it/config.json`:
359
375
  ```
360
376
 
361
377
  **Monorepo (Lockstep):**
378
+
362
379
  ```json
363
380
  {
364
381
  "repos": {
@@ -422,10 +439,6 @@ Based on [autoship](https://github.com/vercel-labs/autoship) v0.2.0 by Vercel La
422
439
 
423
440
  Apache-2.0
424
441
 
425
- ## Author
426
-
427
- Matt Apperson
428
-
429
442
  ## Repository
430
443
 
431
- https://github.com/mattapperson/just-ship-it
444
+ <https://github.com/openrouterteam/just-ship-it>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "just-ship-it",
3
- "version": "0.0.1",
3
+ "version": "0.0.3",
4
4
  "description": "Automate changeset-based releases with AI-generated descriptions powered by OpenRouter",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -39,6 +39,6 @@
39
39
  "license": "Apache-2.0",
40
40
  "repository": {
41
41
  "type": "git",
42
- "url": "https://github.com/mattapperson/just-ship-it"
42
+ "url": "https://github.com/openrouterteam/just-ship-it"
43
43
  }
44
44
  }