Merge pull request #30 from get-convex/ian/workpool

Use Workpool for actions: enables retries & parallelism limits

Author: ianmacartney

.github/workflows/node.js.yml

@@ -0,0 +1,19 @@
+name: Run tests
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+      - run: npm i
+      - run: npm ci
+      - run: cd example && npm i && cd ..
+      - run: npm run typecheck
+      - run: cd example && npm run lint && cd ..
+      - run: npm test

CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Developing guide
+
+## Running locally
+
+```sh
+npm i
+cd example
+npm i
+npx convex dev
+```
+
+## Testing
+
+```sh
+rm -rf dist/ && npm run build
+npm run typecheck
+npm run test
+cd example
+npm run lint
+cd ..
+```
+
+## Deploying
+
+### Building a one-off package
+
+```sh
+rm -rf dist/ && npm run build
+npm pack
+```
+
+### Deploying a new version
+
+```sh
+# this will change the version and commit it (if you run it in the root directory)
+npm version patch
+npm publish --dry-run
+# sanity check files being included
+npm publish
+git push --tags
+```
+
+#### Alpha release
+
+The same as above, but it requires extra flags so the release is only installed with `@alpha`:
+
+```sh
+npm version prerelease --preid alpha
+npm publish --tag alpha
+```