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 5ca042b1 parent d58af994 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
5It 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
10npm install -g executor
11```
12
13## Use
14
15```bash
16executor doctor --json
17executor up
18executor status --json
19executor 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 @@
1{1{
2 "name": "executor",2 "name": "executor",
3 "version": "0.0.0-local",3 "version": "1.1.0",
4 "description": "Local AI executor with a CLI, local API server, and web UI.",4 "description": "Local AI executor with a CLI, local API server, and web UI.",
5 "keywords": [5 "keywords": [
6 "executor",6 "executor",
@@ -18,7 +18,7 @@ · 11 unmodified lines
18 "type": "git",18 "type": "git",
19 "url": "git+https://github.com/RhysSullivan/executor.git"19 "url": "git+https://github.com/RhysSullivan/executor.git"
20 },20 },
21 "license": "UNLICENSED",21 "license": "MIT",
22 "private": true,22 "private": true,
23 "type": "module",23 "type": "module",
24 "bin": {24 "bin": {
apps/executor/src/distribution/artifact.ts+5−4
@@ -116,15 +116,14 @@ const createPackageJson = (input: { · 115 unmodified lines
116 homepage: input.homepage,116 homepage: input.homepage,
117 bugs: input.bugs,117 bugs: input.bugs,
118 repository: input.repository,118 repository: input.repository,
119 license: input.license ?? "UNLICENSED",119 license: input.license ?? "MIT",
120 type: "module",120 type: "module",
121 private: false,121 private: false,
122 bin: {122 bin: "bin/executor.js",
123 executor: "./bin/executor.js",
124 },
125 files: [123 files: [
126 "bin",124 "bin",
127 "resources",125 "resources",
126 "README.md",
128 "package.json",127 "package.json",
129 ],128 ],
130 engines: {129 engines: {
@@ -156,6 +155,7 @@ export const buildDistributionPackage = async ( · 25 unmodified lines
156 const pgliteDataPath = join(pgliteDistDir, "pglite.data");155 const pgliteDataPath = join(pgliteDistDir, "pglite.data");
157 const pgliteWasmPath = join(pgliteDistDir, "pglite.wasm");156 const pgliteWasmPath = join(pgliteDistDir, "pglite.wasm");
158 const webDistDir = join(repoRoot, "apps/web/dist");157 const webDistDir = join(repoRoot, "apps/web/dist");
158 const readmePath = join(repoRoot, "apps/executor/README.md");
159 const packageName = options.packageName ?? defaults.name;159 const packageName = options.packageName ?? defaults.name;
160 const packageVersion = options.packageVersion ?? defaults.version;160 const packageVersion = options.packageVersion ?? defaults.version;
161 await rm(packageDir, { recursive: true, force: true });161 await rm(packageDir, { recursive: true, force: true });
@@ -203,6 +203,7 @@ export const buildDistributionPackage = async ( · 41 unmodified lines
203 repository: defaults.repository,203 repository: defaults.repository,
204 license: defaults.license,204 license: defaults.license,
205 }));205 }));
206 await cp(readmePath, join(packageDir, "README.md"));
206 await writeFile(launcherPath, createLauncherSource());207 await writeFile(launcherPath, createLauncherSource());
207 await chmod(launcherPath, 0o755);208 await chmod(launcherPath, 0o755);
208 209
apps/executor/src/distribution/metadata.ts+1−1
@@ -33,6 +33,6 @@ export const readDistributionPackageMetadata = async (): Promise<DistributionPac · 32 unmodified lines
33 homepage: metadata.homepage,33 homepage: metadata.homepage,
34 bugs: metadata.bugs,34 bugs: metadata.bugs,
35 repository: metadata.repository,35 repository: metadata.repository,
36 license: metadata.license ?? "UNLICENSED",36 license: metadata.license ?? "MIT",
37 };37 };
38};38};