Skip to content

Commit 6c31fc5

Browse files
authored
chore: polish open source readiness (#31)
1 parent 3778cf1 commit 6c31fc5

8 files changed

Lines changed: 69 additions & 53 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
- name: Setup Node
2828
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
2929
with:
30-
node-version: 22
30+
node-version: 24
3131
cache: npm
3232

3333
- name: Install dependencies

.github/workflows/release-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ jobs:
5050
- name: Setup Node
5151
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
5252
with:
53-
node-version: 22
53+
node-version: 24
5454
registry-url: https://registry.npmjs.org
5555
cache: npm
5656

.node-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
24

CHANGELOG.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Changelog
2+
3+
All notable changes to Draftmora are tracked here.
4+
5+
## 0.1.1 - Unreleased
6+
7+
### Added
8+
9+
- Task artifacts with local file reveal support.
10+
- Task run cancellation controls.
11+
- Force follow-up request flow for active task runs.
12+
- Automatic durable-memory review after chat turns and task execution.
13+
- Advanced OpenAI request settings for reasoning, verbosity, retries, timeout,
14+
cache retention, and transport.
15+
- Configurable web and API ports with IPv6-safe Vite proxy handling.
16+
17+
### Changed
18+
19+
- Redesigned the task detail workspace for denser execution and artifact review.
20+
- Improved run log scrolling and current-step status copy.
21+
- Restricted forced follow-ups to the latest queued request.
22+
- Added transient retry handling for OpenAI provider errors.
23+
- Refreshed dependency versions and CI action pins.
24+
- Moved README-only preview art out of runtime public assets.
25+
26+
## 0.1.0 - 2026-05-05
27+
28+
### Added
29+
30+
- First public npm release of Draftmora.
31+
- Local-first task board with SQLite storage.
32+
- Board and chat workflows with task proposals.
33+
- OpenAI account auth with API-key fallback.
34+
- Durable local `USER.md` and `MEMORY.md` memory files.
35+
- GitHub Actions CI and public package validation.

README.md

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
[![CI](https://github.com/afurm/draftmora/actions/workflows/ci.yml/badge.svg)](https://github.com/afurm/draftmora/actions/workflows/ci.yml)
44
[![npm](https://img.shields.io/npm/v/draftmora?color=CB3837&logo=npm&logoColor=white)](https://www.npmjs.com/package/draftmora)
55
[![License: MIT](https://img.shields.io/badge/license-MIT-111111.svg)](LICENSE)
6-
![Node.js >=22.14](https://img.shields.io/badge/node-%3E%3D22.14-339933?logo=node.js&logoColor=white)
7-
![TypeScript](https://img.shields.io/badge/TypeScript-5.7-3178C6?logo=typescript&logoColor=white)
6+
![Node.js 24 recommended](https://img.shields.io/badge/node-24%20recommended-339933?logo=node.js&logoColor=white)
7+
![TypeScript](https://img.shields.io/badge/TypeScript-6.0-3178C6?logo=typescript&logoColor=white)
88
![SQLite](https://img.shields.io/badge/storage-SQLite-003B57?logo=sqlite&logoColor=white)
99
![OpenAI account auth](https://img.shields.io/badge/OpenAI-account%20auth-412991?logo=openai&logoColor=white)
1010
![Local-first](https://img.shields.io/badge/local--first-yes-111111)
1111

12-
![Draftmora app preview](https://raw.githubusercontent.com/afurm/draftmora/main/public/draftmora-preview.png)
12+
![Draftmora app preview](https://raw.githubusercontent.com/afurm/draftmora/main/.github/assets/draftmora-preview.png)
1313

1414
**Messy ideas in. Clear tasks out.**
1515

@@ -49,7 +49,7 @@ pasting an API key.
4949

5050
## Requirements
5151

52-
- Node.js 22.14 or newer.
52+
- Node.js 24 is recommended. Node.js 22.14 or newer remains supported.
5353
- npm 11 or newer.
5454
- Optional: an OpenAI account connection for supported account-auth models, or
5555
`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
153153
`./data/board.db` from the directory where the command is run. Set
154154
`BOARD_DB_PATH` when you want a fixed database location.
155155

156-
## Release Automation
156+
## Changelog
157157

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).
180159

181160
## Security Model
182161

package-lock.json

Lines changed: 19 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "draftmora",
3-
"version": "0.1.0",
3+
"version": "0.1.1",
44
"description": "Local-first AI agent board with chat, SQLite storage, and OpenAI account auth.",
55
"private": false,
66
"license": "MIT",
@@ -25,6 +25,7 @@
2525
"dist/",
2626
".env.example",
2727
"README.md",
28+
"CHANGELOG.md",
2829
"LICENSE"
2930
],
3031
"publishConfig": {
@@ -63,7 +64,7 @@
6364
"@mariozechner/pi-ai": "^0.73.0",
6465
"dotenv": "^17.4.2",
6566
"fastify": "^5.2.1",
66-
"typebox": "^1.1.37",
67+
"typebox": "^1.1.38",
6768
"zod": "^4.4.3"
6869
},
6970
"devDependencies": {
@@ -79,11 +80,11 @@
7980
"jsdom": "^29.1.1",
8081
"lucide-react": "^1.14.0",
8182
"radix-ui": "^1.4.3",
82-
"react": "^19.2.5",
83-
"react-dom": "^19.2.5",
83+
"react": "^19.2.6",
84+
"react-dom": "^19.2.6",
8485
"react-markdown": "^10.1.0",
8586
"remark-gfm": "^4.0.1",
86-
"shadcn": "^4.6.0",
87+
"shadcn": "^4.7.0",
8788
"tailwind-merge": "^3.5.0",
8889
"tailwindcss": "^4.2.4",
8990
"tsx": "^4.19.2",

0 commit comments

Comments
 (0)