summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorMatthew Miller <matthew@millerti.me>2023-08-20 20:02:26 -0700
committerMatthew Miller <matthew@millerti.me>2023-08-20 20:09:07 -0700
commitbf55d536b2f888b9ce045b80b3c4490468bc41be (patch)
treec51fa8c8b887a1ff9ba9a6e0ef6ed39494033b13
parent6a80f97742aef437b7294e456aff0b33b4f8d733 (diff)
Add HANDBOOK.md
-rw-r--r--HANDBOOK.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/HANDBOOK.md b/HANDBOOK.md
new file mode 100644
index 0000000..a959512
--- /dev/null
+++ b/HANDBOOK.md
@@ -0,0 +1,44 @@
+# Handbook
+
+Notes for myself that I don't want cluttering up the README
+
+## Deployment Process
+
+### Determine which packages need to be published
+
+```
+npx lerna version --no-push
+```
+
+What packages need to be published?
+
+1.
+ - [ ] typescript-types
+1.
+ - [ ] browser
+1.
+ - [ ] server
+
+### 1. Need to publish typescript-types?
+
+```
+pnpm run build:types && (cd packages/typescript-types/npm; pnpm publish)
+```
+
+### 2. Need to publish browser?
+
+```
+pnpm run build:browser && (cd packages/browser; pnpm publish)
+```
+
+### 3. Need to publish Server?
+
+1.
+ - [ ] Make sure the correct version of typescript-types is on NPM
+ - The `npm install` step that dnt performs while building the project pulls from NPM. The build
+ will fail if the version of `typescript-types` specified in `mappings` in **build_npm.ts** is
+ unavailable.
+
+```
+pnpm run build:server && (cd packages/server/npm; pnpm publish)
+```