storymaps 1.2.5 → 1.2.6
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 -0
- package/lib/commands/init.js +2 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -257,6 +257,8 @@ slices:
|
|
|
257
257
|
|
|
258
258
|
Cards support: `name`, `body`, `color`, `status` (done / in-progress / planned / blocked), `points`, `tags`, and `url`.
|
|
259
259
|
|
|
260
|
+
Slices support: `name`, `stories`, `goal` (up to 200 characters), `targetDate` (`YYYY-MM-DD`), and `collapsed` with `closedReason` (complete / closed).
|
|
261
|
+
|
|
260
262
|
## Self-Hosting
|
|
261
263
|
|
|
262
264
|
The CLI works with any storymaps.io instance:
|
|
@@ -267,6 +269,36 @@ storymaps init --site storymaps.yourcompany.com
|
|
|
267
269
|
|
|
268
270
|
See the [main project README](https://github.com/jackgleeson/storymaps.io#self-hosting) for setup instructions.
|
|
269
271
|
|
|
272
|
+
## Development
|
|
273
|
+
|
|
274
|
+
```bash
|
|
275
|
+
npm install
|
|
276
|
+
npm test
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
`npm test` runs the unit tests in `test/unit` with Node's built-in test runner (Node 22 or later). They cover the YAML format, the API client, the change summary, and how a target resolves to a map, with no server needed. CI runs them on Node 22 and 24 for every push to `main` and every pull request.
|
|
280
|
+
|
|
281
|
+
To try a change against a local storymaps.io server, run the CLI from the repo, for example `node bin/storymaps.js pull localhost/<map-id>`.
|
|
282
|
+
|
|
283
|
+
### Releasing
|
|
284
|
+
|
|
285
|
+
1. Commit your changes on `main`.
|
|
286
|
+
2. Bump the version in `package.json` and commit it as "Bump version to x.y.z". Use a patch for fixes and a minor version for new features.
|
|
287
|
+
3. Tag the commit and push both:
|
|
288
|
+
```bash
|
|
289
|
+
git tag vx.y.z
|
|
290
|
+
git push origin main vx.y.z
|
|
291
|
+
```
|
|
292
|
+
4. Check you're logged in to npm, then publish:
|
|
293
|
+
```bash
|
|
294
|
+
npm whoami # if this fails, run npm login
|
|
295
|
+
npm pack --dry-run # optional: list what will be published
|
|
296
|
+
npm publish
|
|
297
|
+
```
|
|
298
|
+
5. Confirm the new version is live with `npm view storymaps version`.
|
|
299
|
+
|
|
300
|
+
Only `bin/`, `lib/`, the README and the licence are published (see `files` in `package.json`).
|
|
301
|
+
|
|
270
302
|
## Licence
|
|
271
303
|
|
|
272
304
|
AGPL-3.0 - see [LICENCE](LICENCE) for details.
|
package/lib/commands/init.js
CHANGED
|
@@ -36,11 +36,6 @@ slices:
|
|
|
36
36
|
stories:
|
|
37
37
|
New Step:
|
|
38
38
|
- name: New Task or Detail
|
|
39
|
-
notes: >-
|
|
40
|
-
Thanks for trying Storymaps.io! If you find it useful, please consider starring the open-source repo:
|
|
41
|
-
https://github.com/jackgleeson/storymaps.io
|
|
42
|
-
|
|
43
|
-
Have a great day!
|
|
44
39
|
`;
|
|
45
40
|
}
|
|
46
41
|
|
|
@@ -83,7 +78,8 @@ export async function initCommand(opts) {
|
|
|
83
78
|
try {
|
|
84
79
|
const { id } = await postMap(baseUrl, output, 'text/yaml');
|
|
85
80
|
output = output.replace(/^(name: My Story Map\n)/, `$1id: ${id}\n`);
|
|
86
|
-
console.log(chalk.green(`Created storymap.yml (map ID: ${id})
|
|
81
|
+
console.log(chalk.green(`Created storymap.yml (map ID: ${id})`));
|
|
82
|
+
console.log(`${chalk.cyan(`${baseUrl}/${id}`)}\n`);
|
|
87
83
|
} catch {
|
|
88
84
|
console.log(chalk.green('Created storymap.yml\n'));
|
|
89
85
|
console.log(chalk.dim('Tip: run "storymaps push" to upload the map when you\'re ready to sync.\n'));
|