History

update distribution packaging: version 1.1.0, MIT license, and README

- Bump version from 0.0.0-local to 1.1.0 - Change license from UNLICENSED to MIT - Simplify bin field to single string entry - Include README.md in distribution package files - Update default license fallback in metadata reader

Rhys Sullivan committed 8 months ago

Commit f74ad4f1 parent 4cb06d04 files · +40 −7Browse files

Unified · Split

4 files
  1. apps/executor/README.md +32 −0
  2. apps/executor/package.json +2 −2
  3. apps/executor/src/distribution/artifact.ts +5 −4
  4. apps/executor/src/distribution/metadata.ts +1 −1
apps/executor/README.md+32−0
@@ -0,0 +1,32 @@
1+# executor
2+
3+`executor` is a local AI executor with a CLI, a local API server, and a web UI.
4+
5+It installs as a user command, starts a single local background server, and serves both the API and frontend from that local process.
6+
7+## Install
8+
9+```bash
10+npm install -g executor
11+```
12+
13+## Use
14+
15+```bash
16+executor doctor --json
17+executor up
18+executor status --json
19+executor down
20+```
21+
22+## What it does
23+
24+- installs a local `executor` command
25+- stores local app data in standard user directories
26+- starts one local daemon process
27+- serves the local API and UI together
28+
29+## Links
30+
31+- Repository: https://github.com/RhysSullivan/executor
32+- Issues: https://github.com/RhysSullivan/executor/issues
apps/executor/package.json+2−2
@@ -1,6 +1,6 @@
11 {
22 "name": "executor",
3− "version": "0.0.0-local",
3+ "version": "1.1.0",
44 "description": "Local AI executor with a CLI, local API server, and web UI.",
55 "keywords": [
66 "executor",
@@ -18,7 +18,7 @@ · 11 unmodified lines
1818 "type": "git",
1919 "url": "git+https://github.com/RhysSullivan/executor.git"
2020 },
21− "license": "UNLICENSED",
21+ "license": "MIT",
2222 "private": true,
2323 "type": "module",
2424 "bin": {
apps/executor/src/distribution/artifact.ts+5−4
@@ -116,15 +116,14 @@ const createPackageJson = (input: { · 115 unmodified lines
116116 homepage: input.homepage,
117117 bugs: input.bugs,
118118 repository: input.repository,
119− license: input.license ?? "UNLICENSED",
119+ license: input.license ?? "MIT",
120120 type: "module",
121121 private: false,
122− bin: {
123− executor: "./bin/executor.js",
124− },
122+ bin: "bin/executor.js",
125123 files: [
126124 "bin",
127125 "resources",
126+ "README.md",
128127 "package.json",
129128 ],
130129 engines: {
@@ -156,6 +155,7 @@ export const buildDistributionPackage = async ( · 25 unmodified lines
156155 const pgliteDataPath = join(pgliteDistDir, "pglite.data");
157156 const pgliteWasmPath = join(pgliteDistDir, "pglite.wasm");
158157 const webDistDir = join(repoRoot, "apps/web/dist");
158+ const readmePath = join(repoRoot, "apps/executor/README.md");
159159 const packageName = options.packageName ?? defaults.name;
160160 const packageVersion = options.packageVersion ?? defaults.version;
161161 await rm(packageDir, { recursive: true, force: true });
@@ -203,6 +203,7 @@ export const buildDistributionPackage = async ( · 41 unmodified lines
203203 repository: defaults.repository,
204204 license: defaults.license,
205205 }));
206+ await cp(readmePath, join(packageDir, "README.md"));
206207 await writeFile(launcherPath, createLauncherSource());
207208 await chmod(launcherPath, 0o755);
208209
apps/executor/src/distribution/metadata.ts+1−1
@@ -33,6 +33,6 @@ export const readDistributionPackageMetadata = async (): Promise<DistributionPac · 32 unmodified lines
3333 homepage: metadata.homepage,
3434 bugs: metadata.bugs,
3535 repository: metadata.repository,
36− license: metadata.license ?? "UNLICENSED",
36+ license: metadata.license ?? "MIT",
3737 };
3838 };

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t