|
3 | 3 | [](https://github.com/afurm/draftmora/actions/workflows/ci.yml) |
4 | 4 | [](https://www.npmjs.com/package/draftmora) |
5 | 5 | [](LICENSE) |
6 | | - |
7 | | - |
| 6 | + |
| 7 | + |
8 | 8 |  |
9 | 9 |  |
10 | 10 |  |
11 | 11 |
|
12 | | - |
| 12 | + |
13 | 13 |
|
14 | 14 | **Messy ideas in. Clear tasks out.** |
15 | 15 |
|
@@ -49,7 +49,7 @@ pasting an API key. |
49 | 49 |
|
50 | 50 | ## Requirements |
51 | 51 |
|
52 | | -- Node.js 22.14 or newer. |
| 52 | +- Node.js 24 is recommended. Node.js 22.14 or newer remains supported. |
53 | 53 | - npm 11 or newer. |
54 | 54 | - Optional: an OpenAI account connection for supported account-auth models, or |
55 | 55 | `OPENAI_API_KEY` for API-key backed task execution. |
@@ -153,30 +153,9 @@ The package starts on `http://127.0.0.1:4141` and stores data in |
153 | 153 | `./data/board.db` from the directory where the command is run. Set |
154 | 154 | `BOARD_DB_PATH` when you want a fixed database location. |
155 | 155 |
|
156 | | -## Release Automation |
| 156 | +## Changelog |
157 | 157 |
|
158 | | -Publishing a GitHub Release whose tag matches `package.json` can publish the |
159 | | -same version to the release page, npm, and GitHub Packages in one workflow. For |
160 | | -example, release tag `v0.1.1` publishes `draftmora@0.1.1` to npm and |
161 | | -`@afurm/draftmora@0.1.1` to GitHub Packages. |
162 | | - |
163 | | -One-time npm setup: |
164 | | - |
165 | | -1. Open the npm package settings for |
166 | | - [`draftmora`](https://www.npmjs.com/package/draftmora). |
167 | | -2. Add a trusted publisher with GitHub Actions. |
168 | | -3. Use owner `afurm`, repository `draftmora`, and workflow filename |
169 | | - `release-publish.yml`. |
170 | | - |
171 | | -The workflow validates dependencies, typecheck, tests, build, and package smoke |
172 | | -before publishing. npm receives the public CLI package users should install with |
173 | | -`npx draftmora`. GitHub Packages receives a scoped mirror package so the repo |
174 | | -sidebar can show a package entry. |
175 | | - |
176 | | -GitHub's repository sidebar "Packages" section is separate from npm. It only |
177 | | -shows packages published to GitHub Packages, not packages published to |
178 | | -npmjs.com. GitHub's npm registry requires a scoped package name, so the GitHub |
179 | | -Packages mirror is published as `@afurm/draftmora`. |
| 158 | +Release notes are tracked in [CHANGELOG.md](CHANGELOG.md). |
180 | 159 |
|
181 | 160 | ## Security Model |
182 | 161 |
|
|
0 commit comments