chore: generate json schema programmatically (#97)

Co-authored-by: Saikat Mitra <saikatmitra91@gmail.com>

.github/workflows/json-schema-upload.yml

@@ -0,0 +1,42 @@
+name: Upload JSON Schema
+
+on: workflow_dispatch
+
+jobs:
+  upload:
+    name: Publish packages
+    timeout-minutes: 8
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 8.5
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Lint
+        run: pnpm lint
+
+      - name: Build
+        run: pnpm build
+
+      - uses: ryand56/r2-upload-action@latest
+        with:
+          r2-account-id: ${{ secrets.R2_ACCOUNT_ID }}
+          r2-access-key-id: ${{ secrets.R2_ACCESS_KEY_ID }}
+          r2-secret-access-key: ${{ secrets.R2_SECRET_ACCESS_KEY }}
+          r2-bucket: ${{ secrets.R2_BUCKET }}
+          source-dir: ./packages/json-schema/dist/
+          destination-dir: ./config/schema/

development/README.md

@@ -42,6 +42,20 @@ Follow these concise steps to set up and contribute to this monorepo:
   pnpm run gen:workspace
   ```
 
+### JSON Schema
+
+Enables auto-completion and linting inside VS Code.
+
+## Development
+
+1. Test the changes locally by changing the schema file in one of the examples to
+    ```json
+    "$schema": "../../packages/json-schema/dist/latest.json",
+    ```
+2. Upload the new version to Cloudflare using github action CI pipeline
+3. Update the schema reference for the examples to the new version
+4. Commit the updated schema file
+
 ### Testing
 
 - **Run Tests**:
@@ -71,4 +85,5 @@ Before creating a pull request (PR), follow these steps:
 
   Follow the prompts presented by the changeset CLI to add the changeset to your PR.
 
-  > Note: If the changes do not require a version upgrade for the packages, you may skip adding a changeset.
+  > Note: If the changes do not require a version upgrade for the packages, you may skip adding a changeset.
+